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.5.3。页面最后更新于 2024-05-22。 查看源代码 或 报告问题.