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 樣式程式碼插入適量的換行符號。

為了避免進行可能不安全的變更，dart format 只會影響空白。

不過，撰寫可讀且一致的程式碼還有很多事情，不僅僅是空白。若要深入了解撰寫和設定 Dart 程式碼樣式的最佳實務，請查看Dart 樣式指南。

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

$ dart help format

除非另有說明，否則本網站上的文件反映的是 Dart 3.6.0。頁面最後更新於 2024-05-22。 檢視來源 或 回報問題。