More than 3 years have passed since last update.

Flutterの`flutter format`コマンドのオプションTips

Posted at 2022-04-17

例えば、以下のように余分なスペースが入ってしまっているコードがあるとします。

lib/hello.dart

Text( 'Hello world')

flutterではflutter format と言うformatを自動で整形してくれるコマンドが用意されているのでこれを使います。

$ flutter format lib
Formatted lib/hello.dart
Formatted 1 files (1 changed) in 0.45 seconds.

以下、flutter formatを扱う際に便利なオプションについて記述します。

formatエラーの際にExit code 1を返したい

CIでformat違反が発生した場合にCI全体をfailさせたい場合など、exit code 1を返却したいケースがあります。
その場合--set-exit-if-changedオプションを追加することで設定可能です。

$ flutter format lib --set-exit-if-changed 
Formatted lib/hello.dart
Formatted 1 files (1 changed) in 0.45 seconds.
Formatting failed: 1

コードの自動整形は行わずに違反が存在するかのチェックだけで充分なケースがあります。
その場合--dry-runオプションを追加することで設定可能です。

$ flutter format lib --set-exit-if-changed --dry-run
Formatted lib/hello.dart
Formatted 1 files (1 changed) in 0.45 seconds.
Formatting failed: 1