@qui-cli/colors

@qui-cli Plugin: Standardized Chalk colors for CLI output


Install

``sh
npm install @qui-cli/colors
`

Usage

`ts
import { Colors } from '@qui-cli/colors';

// use Colors
console.log(
This is a ${Colors.value('value')} and a ${Colors.quotedValue('"quoted value"')}.
);
`

Configuration

Colors provides no configuration options.

Options

Colors adds no user-configurable command line options.

Initialization

Colors requires no initialization

API: console.log styles

$3

A literal value (e.g. 3 or true);

$3

A quoted value (e.g. "hello world"). Quotation marks should be included in the text argument.

$3

A regular expression value (e/g /.+/). Expression delimiters (/) should be included in the text argument.

$3

A URL value (e.g. https://example.com or ./path/to/file).

$3

A file or URL path (e.g. ../../path/to/file).

Highlight the filename by passing a second argument:

`ts
Colors.path('path/to/filename', Colors.value);
`

> path/to/filename

$3

An error message (e.g. Bad things happened!).

API: Node styles

$3

A shell command (e.g. echo "hello world").

Highlight the command name by passing a second argument:

`ts
Colors.command('echo hello world', Colors.keyword);
`

> echo hello world

$3

A keyword (e.g. a shell command), as in:

`ts
console.log(Colors.command(${Colors.keyword('echo')} "hello world"));
`

API: man page styles

$3

The name of an option argument (e.g. --my-fancy-option), as in:

`ts
console.log(
${Colors.optionArg('--my-fancy-option')} ${Colors.quotedValue('"pinkies out"')}
);
`

$3

The name of a flag argument (e.g. --no-errors-please).

$3

The name of a positional argument (e.g. arg0`).