Flutter依赖检查插件dart_depcheck的使用

dart_depcheck 是一个命令行工具，用于检查Flutter/Dart项目中未使用的依赖项。

安装 📥

确保你的机器上已经安装了Dart SDK。

选项1：全局安装 💻

1. 全局安装 dart_depcheck：

   dart pub global activate dart_depcheck
   
   # 或者通过克隆仓库并运行：
   dart pub global activate --source path .
   

2. 在你的Flutter/Dart项目的根目录下运行 dart_depcheck 来检查未使用的依赖项：

   dart_depcheck # 这将检查当前目录中的未使用依赖项。
   dart_depcheck -p /path/to/project # 这将检查指定项目路径中的未使用依赖项。
   dart_depcheck -f bin,test # 这将在指定的额外文件夹（如lib, bin, test）中搜索未使用的依赖项。
   dart_depcheck -e yaml,path # 这将从未使用依赖项检查中排除指定的包（如yaml, path）。
   
   # 你可以结合使用这些选项：
   dart_depcheck -p /path/to/project -f bin,test -e yaml,path
   
   # 显示帮助信息：
   dart_depcheck --help
   

   这将检查 pubspec.yaml 文件中声明的依赖项，并显示项目中发现的未使用依赖项和开发依赖项列表。

选项2：作为依赖项添加 📦

你也可以将 dart_depcheck 添加为Dart项目中的依赖项，并在代码中以编程方式使用它。

在 pubspec.yaml 文件的依赖项部分添加 dart_depcheck：

dependencies:
  dart_depcheck: ^0.0.1

导入该包并在代码中使用 DependencyChecker 方法：

import 'package:dart_depcheck/dart_depcheck.dart';

void main() async {
  await DependencyChecker.check();
}

你还可以指定项目路径、要搜索的额外文件夹以及要排除的包：

import 'package:dart_depcheck/dart_depcheck.dart';

void main() async {
  await DependencyChecker.check(
    projectPath: '/path/to/project',
    additionalFolders: ['bin', 'test'],
    excludePackages: ['yaml', 'path'],
  );
}

贡献 🤝

如果你遇到任何问题或有任何改进建议，请随时在GitHub上打开问题或提交拉取请求。

许可证 📄

该项目根据MIT许可证授权。请参阅LICENSE文件以获取更多详细信息。

待办事项 📝

• ❌ 添加CI/CD进行预合并检查 + 在CI上生成覆盖率报告
• ❌ 添加CI/CD发布到pub.dev并创建GitHub版本
• ❌ 添加分支保护规则

示例代码

以下是一个完整的示例，展示如何在代码中使用 dart_depcheck：

import 'dart:io';
import 'package:dart_depcheck/dart_depcheck.dart';
import 'package:path/path.dart' as path;

void main() async {
  // 创建一个随机目录并添加一些临时文件
  Directory tempDir = Directory.systemTemp.createTempSync('dependency_checker_test');

  final projectPath = tempDir.path;

  final pubspecFile = File(path.join(projectPath, 'pubspec.yaml'));
  pubspecFile.writeAsStringSync('''
        name: test_project
        dependencies:
          package_a: ^1.0.0
          package_b: ^2.0.0
          package_c: ^3.0.0
        dev_dependencies:
          package_d: ^4.0.0
          package_e: ^5.0.0
      ''');

  final libDir = Directory(path.join(projectPath, 'lib'));
  libDir.createSync(recursive: true);
  final dartFile = File(path.join(libDir.path, 'main.dart'));
  dartFile.writeAsStringSync('''
        import 'package:package_a/package_a.dart';
        import 'package:package_b/package_b.dart';
        void main() {}
      ''');

  // 使用方法如下
  final (dep, devDep) = await DependencyChecker.check(
    projectPath: projectPath,
  );

  print('Unused dependencies: $dep');
  print('Unused dev_dependencies: $devDep');

  tempDir.deleteSync(recursive: true);
}

此示例展示了如何创建一个临时项目目录，添加 pubspec.yaml 和 main.dart 文件，并使用 dart_depcheck 检查未使用的依赖项。