cli_badges_dart

在终端打印徽章。是的,就是我们在 README 文件中使用的那些漂亮的小东西,但用于 CLI 应用。

功能

  • 易于使用
  • 内置主题
  • 可定制

这就是它的功能

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
    ]),
);

上面的内容会在终端输出类似的内容

用法

使用非常简单,导入包即可开始创建徽章!

import 'package:cli_badges/cli_badges.dart';

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);
示例输出是模拟的,控制台输出会因终端而略有不同。

徽章结构

徽章由一个标签和一个消息组成 <标签>:<消息>。每个部分都可以通过更改背景颜色、文本颜色和样式来定制。

主题

主题是一种存储徽章配置以供重复使用的方式。

蓝色 theme-blue 青色 theme-cyan
绿色 theme-green 品红色 theme-magenta
红色 theme-red 黄色 theme-yellow

你也可以交换所有主题,这意味着标签的属性将应用于消息,反之亦然。

内置主题

  • 红色 : 红色消息背景
  • 绿色 : 绿色消息背景
  • 蓝色 : 蓝色消息背景
  • 黄色 : 黄色背景上的黑色消息
  • 青色 : 青色背景上的黑色消息
  • 品红色 : 品红色背景上的黑色消息
  • 成功 : 绿色背景上的(*“成功”*)消息
  • 失败 : 红色背景上的(*“失败”*)消息
  • 警告 : 黄色背景上的(*“失败”*)消息
  • 信息 : 蓝色背景上的(*“信息”*)消息

颜色

这是所有可用颜色的列表

  • 红色
  • 黑色
  • 绿色
  • 黄色
  • 蓝色
  • 品红色
  • 青色
  • 白色
  • 亮红色
  • 亮黑色
  • 亮绿色
  • 亮黄色
  • 亮蓝色
  • 亮品红色
  • 亮青色
  • 亮白色

使用主题

有 3 种主要方法可以创建主题徽章

1 - 将主题直接传递给 Badge 构造函数

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

2 - 使用命名构造函数

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

3 - 或通过调用预定义的主题方法

Badge(...).red();

附加信息

这里有一个完整的示例 链接

如果您遇到任何问题或希望添加新功能,请前往 GitHub 存储库提交 issue

想要适用于其他环境或语言的徽章吗?

cli-badges 也适用于其他语言

支持该项目

我倾向于开源我能做到的一切,并且乐于帮助那些可能需要项目帮助的人。

但是,如果您正在使用此项目并且对此感到满意,或者只是想鼓励我继续创作,您可以通过以下几种方式做到:

  • 给项目点星并分享?
  • 报告 bug?
  • 发送反馈
  • 甚至写代码 :P

谢谢!❤️

GitHub

https://github.com/nombrekeff/cli_badges_dart