Flutter代码导入优化插件better_imports的使用

Flutter代码导入优化插件better_imports的使用

better_imports 是一个用于Dart项目的命令行工具，可以对Dart文件中的导入进行排序和组织。用户可以通过各种标志和选项来自定义导入排序的行为。

特性

• 默认配置
• 使用外部配置
• 排序所有 .dart 文件
• 将包导入转换为相对导入并反向操作
• 仅排序特定文件夹
• 仅排序特定文件
• 基于正则表达式的包含或排除过滤
• 忽略特定文件
• 向导入类型/部分添加注释
• 切换控制台输出
• 跟踪/日志记录

示例

之前

library better_imports;
import 'dart:io';
import 'package:better_imports/lib.dart';
import 'cfg_test.dart';
import 'package:dart_style/dart_style.dart';
import '../res/sorter_fixtures.dart';
import 'package:test/test.dart';

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

之后（默认配置）

library better_imports;

// Dart Imports
import 'dart:io';

// Package Imports
import 'package:dart_style/dart_style.dart';
import 'package:test/test.dart';

// Project Imports
import 'package:better_imports/lib.dart';

// Relative Project Imports
import '../res/sorter_fixtures.dart';
import 'cfg_test.dart';

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

使用方法

推荐：本地可执行文件

1. 下载预编译的可执行文件，或者克隆仓库并自行编译。
   • 在项目根目录下：

     dart compile exe .\bin\better_imports.dart
     

     在Linux上：

     dart compile exe ./bin/better_imports.dart -o ./bin/better_imports
     

2. 解压下载的存档或将编译后的可执行文件移动到你选择的文件夹中。
   • 如果需要，为操作系统重命名可执行文件为 better_imports。
3. 将选定的文件夹/可执行文件添加到你的PATH环境变量中。
   • Windows: 如何将路径添加到Windows PATH环境变量
   • Mac: 如何在macOS中设置PATH变量
   • Linux: 如何在Linux中将目录添加到PATH中
     • 可能需要使用 chmod 使文件可执行。
4. 进入你的项目文件夹，根目录。
5. 运行：

   better_imports
   

作为依赖项（这大约慢10倍）

1. 按照通常的包安装说明进行操作。
2. 考虑将其作为 dev_dependency，这样你不会依赖任何其他东西。
3. 运行：

   dart pub run better_imports:better_imports
   

   或在Flutter中：

   flutter pub run better_imports:better_imports
   

在VSCode中保存时自动执行

1. 安装 Run on Save 扩展。
2. 在 settings.json 中添加以下配置：

"emeraldwalk.runonsave": {
    "commands": [
        {
            "match": "\\.dart$",
            "cmd": "better_imports --files ${fileBasename} -s"
        }
    ]
}

CLI标志和选项

标志

选项

其他信息

覆盖默认值

你可以通过在 pubspec.yaml 文件中添加一个 better_imports 部分来覆盖默认配置值。 或者通过提供命令行参数。

注意：如果提供了命令行参数，它们将覆盖任何其他设置！

例如： 复制并粘贴默认配置到你的 pubspec.yaml 文件中。 确保保持适当的缩进。

外部配置

如果你想使用外部配置文件，可以在 pubspec.yaml 文件中添加一个最小化的 better_imports 部分。 例如：

better_imports:
  cfg_path: path/to/your/config/cfg.yaml

— 或 —

提供 --cfg CLI 选项。 例如：

better_imports --cfg path/to/your/config/cfg.yaml

默认YAML配置

# Better Imports 默认配置
# 当在CLI中传递设置时，将覆盖默认配置
better_imports:
  # 如果设置，将覆盖项目名称
  # 用于排序项目导入
  project_name:

  # 外部配置的绝对路径
  # 如果设置，本节中的其余部分将被忽略
  cfg_path:

  # 标志以包括子文件夹
  recursive: true

  # 标志以在导入类型/部分上方添加注释
  comments: true

  # 标志以禁用控制台结果输出
  silent: false

  # 标志以在项目中使用相对导入
  relative: false

  # 标志以记录所有发生的事件到控制台
  trace: false

  # 标志以运行干跑，不更改文件
  dry_run: false

  # 标志以在排序导入后使用Dart格式化程序
  dart_fmt: true

  # 用于收集Dart文件的文件夹名称
  folders:
    - lib
    - bin
    - res
    - example
    - test
    - tests
    - integration_test
    - integration_tests
    - test_driver

  # 应该排序的文件名
  files:

  # 应该被排除的文件名
  ignore_files:

  # 应该收集的文件的正则表达式模式
  files_like:

  # 应该被排除的文件的正则表达式模式
  ignore_files_like:
    - .*generated_plugin_registrant\.dart
    - .*\.g\.dart
    - .*\.gr\.dart
    - .*\.freezed\.dart