CLI Badges
Generate Badges for your CLI.
Features
- Make Beautiful Badges for CLI ๐คฉ
- Works across all terminals ๐ฆ
- Link support ๐
- Variety of colors to choose from ๐จ
- Written in TS with Deno ๐ฆ
Usage
import { badge } from "https://deno.land/x/cli_badges@v0.1.0/mod.ts";
console.log(badge("failed", "2", { msgBg: "red" }));
console.log(badge("success", "2", { msgBg: "green" }));
console.log(badge("skipped", "2", { msgBg: "yellow" }));
Output
badge
function
badge
function accepts the following arguments:
-
label
: label of the badge -
msg
: message of the badge -
opts
: accepts an interface ofBadgeOptions
BadgeOptions
Interface
interface BadgeOptions {
msgBg: string; // default is blue
labelBg: string; // default is brightBlack
msgColor: string; // default is white
labelColor: string; // default is white
msgStyle?: string; // default is null
labelStyle?: string; // default is null
msgWidth?: number; // default is msg length + 2
labelWidth?: number; // default is label length + 2
is_8bit?: boolean; // default is false as it uses 24 bits
hyper_link?: string; // hyperlink for the badge
}
Available Options
Foreground Colors
black
red
blue
green
yellow
magenta
cyan
white
brightBlack
brightRed
brightBlue
brightGreen
brightYellow
brightMagenta
brightCyan
brightWhite
Background Colors
black
red
blue
green
yellow
magenta
cyan
white
brightBlack
brightRed
brightBlue
brightGreen
brightYellow
brightMagenta
brightCyan
brightWhite
Styles
bold
italic
inverse
dim
strike
underline
Custom Colors
Custom Colors are available and can be used for msgBg
, labelmsg
, msgColor
and labelColor
only. There are options to make 8 bit
and 24 bit
colors respectively. Set is_8bit
to true if you want custom 8 bit RGB colors else it will be set to 24 bit RBG colors by default.
NOTE: 24 bit
Colors must be in a range of 0x000000
and 0xffffff
and 8 bit
Colors must in a range of 0x0
and 0xFF
.
Hyperlink Support
Hyperlink is only supported on some terminals.
Acknowledgments
I thank the author of nombrekeff/cli-badges for his original implementation in JS wth Node and also helped me with some Deno issues and giving me guidance on this project as this is my first project with TS.
GitHub
Delta456 / cli_badges
Generate Badges for your CLI written in ๐ฆ Deno and TS
CLI Badges
Generate Badges for your CLI.
NOTE: It is recommended to update pre-exisiting versions of this module to ^v0.1.0
as there are many breaking changes from this release in the API.
Features
- Make Beautiful Badges for CLI ๐คฉ
- Works across all terminals ๐ฆ
- Link support ๐
- Variety of colors to choose from ๐จ
- Written in TS with Deno ๐ฆ
Warning
โ ๏ธ : If your terminal has a custom theme then the colors will blend according to your configuration which can cause unwanted results.
Usage
Simple Example
Showcases failed
, success
and skipped
badge on the terminal
import { badge } from "https://deno.land/x/cli_badges@v0.1.1/mod.ts";
console.log(badge("failed", "2", { msgBg: "red" }));
console.log(badge("success", "2", { msgBg: "green" }));
console.log(badge("skipped", "2"
โฆ
Top comments (0)