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

查看 格式化程序 FAQ，了解有关格式化决策的更多背景信息。

除非另有说明，否则本网站上的文档反映了 Dart 3.7.1 版本。页面上次更新于 2025-01-31。 查看源代码 或 报告问题。