dart format

コードをDartフォーマットガイドラインに準拠するように更新するには、dart formatコマンドを使用します。このフォーマットは、DartをサポートするIDEまたはエディタを使用した場合と同じ結果になります。

1つ以上のDartファイルを再フォーマットするには、目的のファイルまたはディレクトリへのパスのリストを指定します。

1つのファイルまたはディレクトリへのパスを指定します。ディレクトリを指定した場合、`dart format`は直下のファイルのみに影響し、サブディレクトリは再帰的に処理されません。

例：カレントディレクトリ内またはカレントディレクトリ以下のすべてのDartファイルをフォーマットする

$ dart format .

複数のファイルまたはディレクトリを指定するには、スペース区切りのリストを使用します。

例：`lib`ディレクトリ以下のすべてのDartファイルと、`bin`ディレクトリ以下の1つのDartファイルをフォーマットする

$ dart format lib bin/updater.dart

デフォルトでは、`dart format`はDartファイルを**上書き**します。

• ファイルを上書きしないようにするには、`--output`または`-o`フラグを追加します。
• フォーマットされたファイルの内容を取得するには、`-o show`または`-o json`を追加します。
• どのファイルが変更されるかのみを確認するには、`-o none`を追加します。

$ dart format -o show bin/my_app.dart

フォーマットの変更が発生した場合に`dart format`が終了コードを返すようにするには、`--set-exit-if-changed`フラグを追加します。

• 変更が発生した場合、`dart format`コマンドは終了コード`1`を返します。
• 変更が発生しない場合、`dart format`コマンドは終了コード`0`を返します。

継続的インテグレーション（CI）システムで終了コードを使用して、終了コードに応じて別の処理をトリガーできます。

$ dart format -o none --set-exit-if-changed bin/my_app.dart

自動フォーマットを改善するために、オプションの末尾カンマを使用します。関数、メソッド、コンストラクタのパラメータリストの末尾に末尾カンマを追加します。これは、フォーマッタがDartスタイルのコードに適切な量の改行を挿入するのに役立ちます。

安全でない可能性のある変更を防ぐため、`dart format`は空白のみに影響します。

ただし、読みやすく一貫性のあるコードを作成するには、空白以上のものが重要です。Dartコードの作成とスタイル設定のベストプラクティスについては、Dartスタイルガイドをご覧ください。

追加のコマンドラインオプションについては、`dart help`コマンドを使用するか、dart_styleパッケージのドキュメントを参照してください。

$ dart help format

特に明記されていない限り、このサイトのドキュメントはDart 3.5.3を反映しています。ページの最終更新日：2024-05-22。 ソースを表示 または 問題を報告する。