Flutter徽章生成插件 cli_badges 的使用

cli_badges 是一个用于在命令行界面（CLI）应用程序中生成徽章的小型 Dart 库。本文将介绍如何在 Flutter 项目中使用该插件，并提供完整的示例代码。

特性

• 简单易用
• 内置主题
• 可自定义

安装

首先，在你的 pubspec.yaml 文件中添加 cli_badges 依赖：

dependencies:
  cli_badges: ^1.0.0  # 请根据最新版本号进行修改

然后运行以下命令来安装依赖：

flutter pub get

使用示例

基本用法

导入库并创建一个 Badge 对象：

import 'package:cli_badges/cli_badges.dart';

void main() {
  var failedBadge = Badge(label: 'failed', message: '2', theme: BadgeTheme.red);

  print(failedBadge);
}

更多示例

你可以创建不同类型的徽章，例如捐赠徽章：

var donateBadge = Badge.cyan(label: '❤️ donate', message: 'please?');

print(donateBadge);

你也可以只显示标签：

var onlyLabel = Badge(
    label: '❤️ donate', 
    labelColorCode: 169
);

print(onlyLabel);

组合多个徽章

你可以将多个徽章组合在一起打印：

var failedBadge  = Badge(label: 'failed', message: '2', theme: BadgeTheme.red);
var successBadge = Badge(label: 'success', message: '2').green();
var skippedBadge = Badge.yellow(label: 'skipped',  message: '2');

print(
    Badge.inline([
        failedBadge, 
        skippedBadge, 
        successBadge
    ]),
);

使用内置主题

cli_badges 提供了多种内置主题，例如红色、绿色、蓝色等。以下是三种创建主题徽章的方法：

1. 直接传递主题到构造函数：

Badge(
    label: 'failed', 
    message: '2', 
    theme: BadgeTheme.red,
);

1. 使用命名构造函数：

Badge.red(
    label: 'failed', 
    message: '2', 
);

1. 调用预定义的主题方法：

Badge(...).red();

颜色列表

以下是所有可用的颜色列表：

• red
• black
• green
• yellow
• blue
• magenta
• cyan
• white
• brightRed
• brightBlack
• brightGreen
• brightYellow
• brightBlue
• brightMagenta
• brightCyan
• brightWhite

自定义主题

你可以通过设置背景颜色和文本颜色来自定义主题：

var customBadge = Badge(
    label: 'custom', 
    message: '1', 
    labelBackgroundColor: Colors.blue,
    labelTextColor: Colors.white,
    messageBackgroundColor: Colors.green,
    messageTextColor: Colors.black,
);

print(customBadge);

完整示例 Demo

下面是一个完整的示例程序，展示如何使用 cli_badges 插件生成不同的徽章：

import 'package:cli_badges/cli_badges.dart';
import 'dart:io';

void main() {
  // 创建失败徽章
  var failedBadge = Badge(label: 'failed', message: '2', theme: BadgeTheme.red);

  // 创建成功徽章
  var successBadge = Badge(label: 'success', message: '2').green();

  // 创建跳过徽章
  var skippedBadge = Badge.yellow(label: 'skipped', message: '2');

  // 打印组合徽章
  print('Combined Badges:');
  print(
      Badge.inline([
          failedBadge, 
          skippedBadge, 
          successBadge
      ]),
  );

  // 创建捐赠徽章
  var donateBadge = Badge.cyan(label: '❤️ donate', message: 'please?');
  print('\nDonate Badge:');
  print(donateBadge);

  // 创建自定义徽章
  var customBadge = Badge(
      label: 'custom', 
      message: '1', 
      labelBackgroundColor: Colors.blue,
      labelTextColor: Colors.white,
      messageBackgroundColor: Colors.green,
      messageTextColor: Colors.black,
  );
  print('\nCustom Badge:');
  print(customBadge);

  // 检查是否在终端环境中运行
  if (Platform.isWindows || Platform.isLinux || Platform.isMacOS) {
    print('\nRunning in terminal environment.');
  } else {
    print('\nNot running in terminal environment.');
  }
}

结论

cli_badges 是一个非常实用的 Dart 库，可以帮助你在 CLI 应用程序中快速生成各种徽章。通过简单的 API 和丰富的自定义选项，你可以轻松创建出符合需求的徽章。希望这篇指南对你有所帮助！如果你有任何问题或建议，请访问 GitHub 仓库 并提交 issue。