パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.0.2

cli_badges

ターミナルにバッジを出力します。はい、READMEで使う便利な小さなアイテムですが、CLIアプリ向けです。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
3.8万
いいね数
10
Pub ポイント
130

パッケージをインストール

flutter pub add cli_badges

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

CLI アプリケーションがターミナルにカラフルでスタイリッシュなバッジを直接表示できるようにする Dart パッケージです。README ファイルに見られるバッジと同様のものです。ステータス、バージョン、ビルド情報などの視覚的インジケーターを使ってコマンドライン出力を強化するのに最適です。複数のプラットフォームをサポートしており、Flutter や Dart CLI ツールにスムーズに統合できます。最小限のセットアップで、開発者はコンソールログにプロフェッショナルな見た目のバッジを追加でき、ターミナルベースのワークフローにおける読みやすさとユーザー体験を向上させます。

用途

  • 視覚的なステータスインジケーターでCLI出力を強化
  • ターミナルでバージョンおよびビルド情報を表示する
  • 開発者ツールにおけるログの可読性の向上
  • コマンドラインアプリにブランデッドバッジを追加する
  • インタラクティブなCLIダッシュボードの作成

主な機能

  • ターミナルバッジのレンダリング
  • クロスプラットフォーム対応
  • バッジ作成のためのシンプルな API
  • カラフルでカスタマイズ可能なバッジ
  • 軽量で統合が簡単

適している対象

  • CLI ツール開発者
  • DevOps および自動化スクリプト
  • Flutter CLI 拡張
  • 開発者体験(DX)の向上
  • コマンドラインアプリケーションのメンテナー

注意事項

  • 端末出力のみに制限
  • テキスト以外の環境に対応していません
  • 端末の色表示機能に依存します
  • すべてのターミナルタイプで一貫してレンダリングされない可能性があります
  • 最新の ANSI 対応ターミナルに最適

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Quirky little dart library for generating badges for your cli apps.

Pub Version


Print badges to the terminal. Yup, those nifty little thingies we use on readmes, but for CLI apps.

Features

  • Easy to use
  • Inbuilt themes
  • Customizable

This is what it can do:

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

The above would output something similar to the terminal:

Usage

Usage is simple, import the package and start creating Badges!

import 'package:cli_badges/cli_badges.dart';

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

print(failedBadge);
Some more examples:

You could create a donate badge:

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

print(donateBadge);

You can also only show the label:

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

print(onlyLabel);
Example output is a mock, console output will vary slightly from terminal to terminal.

Badge Structure

A badge is conformed of a label and a message <label>:<message>. Each segment can be customized, by changing bg color, text color and style.

Themes

Themes are a way to store badge configuration for repeated use.

blue theme-blue cyan theme-cyan
green theme-green magenta theme-magenta
red theme-red yellow theme-yellow

You can also swap all themes, this means properties from label will be applied to message and vice versa.

Inbuilt themes
  • red : Red Message Background
  • green : Green Message Background
  • blue : Blue Message Background
  • yellow : Black Colored Message on yellow Background
  • cyan : Black Colored Message on cyan Background
  • magenta : Black Colored Message on magenta Background
  • success : ('Success') Message on green Background
  • failed : ('Failed') Message on red Background
  • warning : ('Failed') Message on yellow Background
  • info : ('Info') Message on blue Background
Colors

This is the list of all available colors:

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

There are 3 main ways to create a themed badge:

1 - Passing in the theme directly to the Badge constructor:
Badge(
    label: 'failed', 
    message: '2', 
    theme: BadgeTheme.red,
);
2 - Using named constructors:
Badge.red(
    label: 'failed', 
    message: '2', 
);
3 - Or by calling the predefined theme methods:
Badge(...).red();

Additional info

There is a complete example here

If you encounter any problems or fancy a feature to be added please head over to the GitHub repository and drop an issue.

Want badges for some other environment or language?

cli-badges is also available in other languages:

Support the project

I tend to open source anything I can, and love to help people that might need help with the project.

However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are few ways you can do so:

  • Starring and sharing the project 🚀
  • Reporting bugs 🐛
  • Sending feedback
  • Or even coding :P

Thanks! ❤️

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。