Flutter插件m_cli_core的使用_m_cli_core是一个用于支持命令行应用程序的Dart包

Flutter插件m_cli_core的使用_m_cli_core是一个用于支持命令行应用程序的Dart包

m_cli_core概述

m_cli_core 是一个用于支持命令行应用程序的Dart包。它主要用于生成测试覆盖率徽章，并提供了一些基础功能来处理命令行参数和执行命令。

m_cli_core安装与激活

首先，确保你已经安装了Dart SDK。然后，在你的项目中添加 m_cli_core 依赖到 pubspec.yaml 文件中：

dependencies:
  m_cli_core: ^版本号

运行以下命令来获取并安装依赖：

dart pub get

运行测试

要运行所有的单元测试，可以使用以下步骤：

1. 激活 coverage 工具：

   dart pub global activate coverage
   

2. 生成覆盖率报告：

   dart test --coverage=coverage
   

3. 将覆盖率数据格式化为LCOV格式：

   dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info
   

4. 生成覆盖率报告并打开：

   genhtml coverage/lcov.info -o coverage/
   open coverage/index.html
   

示例代码

以下是一个简单的示例，展示了如何使用 m_cli_core 创建一个命令行应用程序。

main.dart

import 'package:args/command_runner.dart';
import 'package:m_cli_core/m_cli_core.dart';

void main(List<String> arguments) async {
  // 创建一个命令行程序实例
  var runner = CommandRunner(
    'badge-test',  // 命令行程序名称
    'CLI arc supporter generator test coverage badge',  // 命令行程序描述
  )
    ..addCommand(ExampleCommand())  // 添加命令
    ..argParser.addFlag(
      'verbose',  // 添加一个标志
      abbr: 'v',  // 缩写
      negatable: false,  // 不可否定
      help: 'Noisy logging, including all shell commands executed.',  // 帮助信息
    );
  
  // 执行命令
  await runner.run(arguments);
}

// 定义一个命令类
class ExampleCommand extends BaseCommand {
  ExampleCommand() : super();

  @override
  String get description => "echo text";  // 命令描述

  @override
  String get name => "echo";  // 命令名称

  @override
  List<CommandOption> get provideOptions => [
        CommandOption(
          name: "text",  // 选项名称
          help: "The input text to echo (required).",  // 选项帮助信息
          valueHelp: 'text',  // 选项值的帮助信息
          isMandatory: true,  // 是否必须
        )
      ];

  @override
  Future<void> onCommandExecuted() async {
    // 获取命令行参数
    final optionIn = getOptionAt(0);
    final inputText = optionIn.getArgOption<String>(argResults: argResults);

    // 输出文本
    ConsoleUtils.echoText(message: inputText ?? "");
    // 更新结束消息
    updateEndingMessage("Your text has been echo");
  }
}

生成徽章

要生成测试覆盖率徽章，可以使用以下命令：

badge-test gen --in=coverage/lcov.info