Flutter代码格式化插件dart_style的使用

发布于 1周前 作者 sinazl 来自 Flutter

Flutter代码格式化插件dart_style的使用

dart_style 插件为Dart代码定义了一个有主见的自动化格式化工具。它会用其认为最适合的格式替换程序中的空白。此外，它还会对非语义标点符号（如尾随逗号和参数列表中的括号）进行微调。

格式化后的代码应遵循Dart风格指南，并且大多数时候对大多数人来说看起来都很美观。

格式化文件

格式化器处理缩进、内联空白以及（最困难的部分）智能换行。它在处理嵌套集合、函数表达式、长参数列表或其它棘手代码时没有任何问题。

例如，下面是一段未格式化的代码：

// BEFORE formatting
process = await Process.start(path.join(p.pubCacheBinPath,Platform.isWindows
?'${command.first}.bat':command.first,),[...command.sublist(1),'web:0',
// Allow for binding to a random available port.
],workingDirectory:workingDir,environment:{'PUB_CACHE':p.pubCachePath,'PATH':
path.dirname(Platform.resolvedExecutable)+(Platform.isWindows?';':':')+
Platform.environment['PATH']!,},);

经过dart_style格式化后，代码变为：

// AFTER formatting
process = await Process.start(
  path.join(
    p.pubCacheBinPath,
    Platform.isWindows ? '${command.first}.bat' : command.first,
  ),
  [
    ...command.sublist(1), 'web:0',
    // Allow for binding to a random available port.
  ],
  workingDirectory: workingDir,
  environment: {
    'PUB_CACHE': p.pubCachePath,
    'PATH':
        path.dirname(Platform.resolvedExecutable) +
        (Platform.isWindows ? ';' : ':') +
        Platform.environment['PATH']!,
  },
);

格式化器不会破坏你的代码——你可以安全地从构建和预提交脚本中自动调用它。

使用命令行格式化文件

格式化器是统一的 dart 开发者工具的一部分，包含在 Dart SDK 中，因此大多数用户直接从那里使用 dart format 命令来运行它。

支持 Dart 的 IDE 和编辑器通常提供简单的方法来运行格式化器。例如，在 Visual Studio Code 中，格式化 Dart 代码将默认使用 dart_style 格式化器。大多数用户将其设置为每次保存文件时重新格式化。

这是一个简单的命令行使用示例：

$ dart format my_file.dart

该命令格式化 my_file.dart 文件并将结果写回同一文件。

dart format 命令接受一个路径列表，这些路径可以指向目录或文件。如果路径是一个目录，它会处理该目录及其所有子目录中的每个 .dart 文件。

默认情况下，dart format 会格式化每个文件并将结果写回相同的文件。如果你传递 --output show 参数，它会将格式化后的代码打印到标准输出，并且不修改文件。

验证格式化

如果你想在预提交脚本或提交钩子中使用格式化器，可以通过传递标志来避免将格式化更改写入磁盘，并更新退出代码以指示成功/失败：

$ dart format --output=none --set-exit-if-changed .

将格式化器作为库使用

dart_style 包公开了一个简单的库API用于格式化代码。基本用法如下所示：

import 'package:dart_style/dart_style.dart';

void main() {
  final formatter = DartFormatter();

  try {
    print(formatter.format("""
    library an_entire_compilation_unit;

    class SomeClass {}
    """));

    print(formatter.formatStatement("aSingle(statement);"));
  } on FormatterException catch (ex) {
    print(ex);
  }
}

其他资源

  • 在发送邮件之前，请查看你是否在询问一个常见问题。
  • 在提交错误报告之前，或者如果你想了解格式化器的工作是如何管理的，请参阅我们如何跟踪问题。

通过以上内容，您可以更好地理解和使用 dart_style 插件来保持Flutter项目的代码整洁和一致。


更多关于Flutter代码格式化插件dart_style的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

Harmonyos Next教程
1 回复

更多关于Flutter代码格式化插件dart_style的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter项目中使用dart_style插件进行Dart代码格式化的详细步骤和相关代码案例。

dart_style是Dart语言的官方代码格式化工具，Flutter项目中的Dart代码同样适用。虽然dart_style本身不是一个插件（它是一个命令行工具），但可以通过集成到IDE或使用脚本在项目中自动化代码格式化。

1. 安装Dart SDK

首先，确保你已经安装了Dart SDK。Flutter SDK包含了Dart SDK，所以如果你已经安装了Flutter，那么Dart也已经安装好了。

2. 使用命令行工具dart_format

Dart SDK提供了一个名为dart format的命令，可以用来格式化Dart文件。你可以在终端或命令行界面中运行这个命令。

格式化单个文件

dart format path/to/your_file.dart

格式化整个项目

你可以使用find命令（在Linux/macOS上）或dir命令（在Windows上）结合dart format来格式化整个项目中的Dart文件。

例如，在Linux/macOS上：

find . -name "*.dart" -exec dart format {} \;

在Windows上（使用PowerShell）：

Get-ChildItem -Recurse -Include *.dart | ForEach-Object { dart format $_.FullName }

3. 在IDE中集成代码格式化

大多数流行的IDE和编辑器（如VS Code、Android Studio、IntelliJ IDEA等）都支持Dart代码格式化，并且已经内置了对dart_style的支持。

在VS Code中

  1. 确保你已经安装了Dart和Flutter扩展。
  2. 打开一个Dart文件。
  3. 右键点击编辑器中的任意位置，选择“Format Document”。
  4. 或者，你可以使用快捷键（通常是Shift + Alt + F）。

VS Code还会在你保存文件时自动格式化代码，这可以在设置中进行配置：

// settings.json
{
    "editor.formatOnSave": true,
    "[dart]": {
        "editor.formatOnSave": true,
        "editor.defaultFormatter": "Dart-Code.flutter"
    }
}

4. 使用脚本自动化代码格式化

你可以编写一个简单的脚本来格式化项目中的所有Dart文件。以下是一个使用Bash的示例脚本：

#!/bin/bash

# Find all Dart files in the current directory and its subdirectories
find . -name "*.dart" | while read -r file; do
    # Format each Dart file
    dart format "$file"
done

echo "All Dart files have been formatted."

将上述脚本保存为format_dart_files.sh，然后给予执行权限并运行：

chmod +x format_dart_files.sh
./format_dart_files.sh

总结

通过上述方法，你可以很方便地在Flutter项目中使用dart_style进行Dart代码的格式化。无论是通过命令行工具、IDE集成还是自动化脚本，dart_style都能确保你的代码风格一致且符合Dart的官方标准。

回到顶部