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 個字元行長度或更短。如果您想要為您的專案設定行長度，您可以將最上層的 formatter 區段新增至 analysis_options.yaml 檔案，如下所示

formatter:
  page_width: 123

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

您也可以設定個別檔案的行長度，覆寫分析選項檔案，方法是在檔案頂端、任何其他程式碼之前新增標記註解

// dart format width=123

若要了解其他命令列選項，請使用 dart help 命令或查看 dart_style 套件 的文件

$ dart help format

請查看格式器常見問題以取得更多關於格式化決策的背景資訊。

除非另有說明，否則本網站上的文件反映的是 Dart 3.7.1。頁面最後更新於 2025-01-31。 檢視原始碼 或 回報問題。