dart format

要將您的程式碼更新為遵循 Dart 格式化指南，請使用 dart format 命令。此格式化與您使用支援 Dart 的 IDE 或編輯器時獲得的效果一致。

要重新格式化一個或多個 Dart 檔案，請提供所需檔案或目錄的路徑列表。

提供單個檔案或目錄的路徑。如果您傳遞目錄路徑，dart format 也會遞迴進入其子目錄。

示例：格式化當前目錄或其下的所有 Dart 檔案

dart format .

要指定多個檔案或目錄，請使用空格分隔的列表。

示例：格式化 lib 目錄下的所有 Dart 檔案，以及 bin 目錄下的一個 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 format 進行以下格式化更改：

• 移除空白。
• 將每行包裹成 80 個字元或更短。
• 為任何跨多行分割的引數或形參列表新增尾隨逗號，並從不跨多行的列表中移除它們。
• 可能會將註釋移到逗號之前或之後。

要了解編寫和美化 Dart 程式碼的最佳實踐，請查閱Dart 樣式指南。

當您執行 dart format 時，格式化程式預設將行長度設定為 80 個字元或更短。如果您想為您的專案配置行長度，可以在 analysis_options.yaml 檔案中新增一個頂層 formatter 部分，如下所示：

formatter:
  page_width: 123

由於分析選項檔案通常位於根目錄，因此配置的行長度將適用於包中的所有內容。

您還可以透過在檔案頂部、任何其他程式碼之前新增標記註釋來配置單個檔案的行長度，這會覆蓋分析選項檔案：

// dart format width=123

要了解其他命令列選項，請使用 dart help 命令或參閱 dart_style 包的文件。

dart help format

請查閱格式化程式常見問題解答，瞭解格式化決策背後的更多背景資訊。