Pakete, Repositories und App-Kategorien suchen

Paketdetailsv0.0.2

cli_badges

Badges in die Terminalausgabe drucken. Ja, jene nützlichen kleinen Dinge, die wir in Readmes verwenden, aber für CLI-Anwendungen.

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
38.100
Likes
10
Pub-Punkte
130

Paket installieren

flutter pub add cli_badges

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

Ein Dart-Paket, das CLI-Anwendungen ermöglicht, farbenfrohe, stilvolle Badges direkt im Terminal auszugeben – ähnlich wie in README-Dateien zu sehen. Es ist ideal, um die Befehlszeilen-Ausgabe mit visuellen Indikatoren wie Status, Version oder Build-Informationen zu verbessern. Das Paket unterstützt mehrere Plattformen und lässt sich nahtlos in Flutter- und Dart-CLI-Tools integrieren. Mit minimalem Aufwand können Entwickler professionell aussehende Badges in Konsolen-Logs hinzufügen, was die Lesbarkeit und Benutzererfahrung bei terminalbasierten Workflows verbessert.

Anwendungsfälle

  • Verbesserung der CLI-Ausgabe durch visuelle Statusindikatoren
  • Anzeigen von Versions- und Build-Informationen in Terminals
  • Verbesserung der Lesbarkeit von Protokollen in Entwicklerwerkzeugen
  • Markenbadges zu Befehlszeilenanwendungen hinzufügen
  • Interaktive CLI-Dashboards erstellen

Hauptmerkmale

  • Terminal-Badge-Rendern
  • Plattformübergreifende Unterstützung
  • Einfache API für Badge-Erstellung
  • Bunte und anpassbare Abzeichen
  • Leichtgewichtig und einfach zu integrieren

Geeignet für

  • CLI-Tool-Entwickler
  • DevOps und Automatisierungsskripte
  • Flutter CLI-Erweiterungen
  • Verbesserungen der Entwicklererfahrung (DX)
  • Entwickler von Befehlszeilenanwendungen

Hinweise

  • Beschränkt auf Terminal-Ausgabe nur
  • Keine Unterstützung für nicht-textbasierte Umgebungen
  • Abhängig von den Farbfähigkeiten des Terminals
  • Kann nicht konsistent in allen Terminaltypen dargestellt werden
  • Am besten geeignet für moderne Terminals mit ANSI-Unterstützung

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

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! ❤️

Kategorien

Quell-Repository

Projekte, die dieses Paket verwenden

Noch keine Daten verfügbar.