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