cli-color

Yet another colors and formatting for the console solution

Colors, formatting and other goodies for the console. This package won't mess with built-ins and provides neat way to predefine formatting patterns, see below.

Installation

$ npm install cli-color

Usage

Usage:

1var clc = require("cli-color");

Output colored text:

1console.log(clc.red("Text in red"));

Styles can be mixed:

1console.log(clc.red.bgWhite.underline("Underlined red text on white background."));

Styled text can be mixed with unstyled:

1console.log(clc.red("red") + " plain " + clc.blue("blue"));

Styled text can be nested:

1console.log(clc.red("red " + clc.blue("blue") + " red"));

Best way is to predefine needed stylings and then use it:

1var error = clc.red.bold;
2var warn = clc.yellow;
3var notice = clc.blue;
4
5console.log(error("Error!"));
6console.log(warn("Warning"));
7console.log(notice("Notice"));

Note: No colors or styles are output when NO_COLOR env var is set

Supported are all ANSI colors and styles:

Styles

Styles will display correctly if font used in your console supports them.

• bold
• italic
• underline
• blink
• inverse
• strike

Colors

Foreground	Background
black	bgBlack
red	bgRed
green	bgGreen
yellow	bgYellow
blue	bgBlue
magenta	bgMagenta
cyan	bgCyan
white	bgWhite

Bright variants

Foreground	Background
blackBright	bgBlackBright
redBright	bgRedBright
greenBright	bgGreenBright
yellowBright	bgYellowBright
blueBright	bgBlueBright
magentaBright	bgMagentaBright
cyanBright	bgCyanBright
whiteBright	bgWhiteBright

xTerm colors (256 colors table)

Not supported on Windows and some terminals. However if used in not supported environment, the closest color from basic (16 colors) palette is chosen.

Usage:

1var msg = clc.xterm(202).bgXterm(236);
2console.log(msg("Orange text on dark gray background"));

Color table:

Reset

Terminal can be cleared with clc.reset

1process.stdout.write(clc.reset);

Erase

clc.erase.screen

Entire screen

1process.stdout.write(clc.erase.screen);

clc.erase.screenLeft

Left portion of a screen

1process.stdout.write(clc.erase.screenLeft);

clc.erase.screenRight

Right portion of a screen

1process.stdout.write(clc.erase.screenRight);

clc.erase.line

Current line

1process.stdout.write(clc.erase.line);

clc.erase.lineRight

Right portion of current line

1process.stdout.write(clc.erase.lineRight);

clc.erase.lineLeft

Left portion of current line

1process.stdout.write(clc.erase.lineLeft);

Move around functions

clc.move(x, y)

Move cursor x columns and y rows away. Values can be positive or negative, e.g.:

1process.stdout.write(clc.move(-2, -2)); // Move cursors two columns and two rows back

clc.move.to(x, y)

Absolute move. Sets cursor position at x column and y row

1process.stdout.write(clc.move.to(0, 0)); // Move cursor to first row and first column in terminal window

clc.move.up(n)

Move cursor up n rows

1process.stdout.write(clc.move.up(2));

clc.move.down(n)

Move cursor down n rows

1process.stdout.write(clc.move.down(2));

clc.move.right(n)

Move cursor right n columns

1process.stdout.write(clc.move.right(2));

clc.move.left(n)

Move cursor left n columns

1process.stdout.write(clc.move.left(2));

clc.move.lines(n)

Move cursor n lines forward if n is positive, otherwise n lines backward, and place it at line beginning

1process.stdout.write(clc.move.lines(2));

clc.move.top

Move cursor to top of a screen

1process.stdout.write(clc.move.top);

clc.move.bottom

Move cursor to bottom of a screen

1process.stdout.write(clc.move.bottom);

clc.move.lineBegin

Move cursor to begin of a line

1process.stdout.write(clc.move.lineBegin);

clc.move.lineEnd

Move cursor to end of a line

1process.stdout.write(clc.move.lineEnd);

Terminal characteristics

clc.windowSize.width

Returns terminal width

clc.windowSize.height

Returns terminal height

Additional functionalities

clc.slice(str[, begin[, end]])

Slice provided string with preservation of eventual ANSI formatting

1var clc = require("cli-color");
2
3var str = clc.bold("foo") + "bar" + clc.red("elo");
4var sliced = clc.slice(str, 1, 7); // Same as: clc.bold('oo') + 'bar' + clc.red('e')

clc.strip(formatedText)

Strips ANSI formatted string to plain text

1var ansiStrip = require("cli-color/strip");
2
3var plain = ansiStrip(formatted);

clc.getStrippedLength(str)

Get actual length of ANSI-formatted string

1var clc = require("cli-color");
2
3var str = clc.bold("foo") + "bar" + clc.red("elo");
4clc.getStrippedLength(str); // 9

clc.art(text, styleConf)

Create a text-graphical art. Within styleConf, string replacements needs to be defined, which are then used to convert text to styled graphical text.

1var text = ".........\n" + ". Hello .\n" + ".........\n";
2var style = { ".": clc.yellowBright("X") };
3
4process.stdout.write(clc.art(text, style));

clc.columns(data[, options])

Outputs aligned table of columns.

data is expected to be an array (or other iterable structure) of rows, where each row is also an array (or other iterable structure) of content to display.

Supported options:

• sep: Custom colums separator (defaults to |)
• columns: Per column customizations, as e.g. [{ align: 'right' }, null, { align: 'left' }]:
  • align: Possible options: 'left', 'right (efaults to 'left')

1var clc = require("cli-color");
2
3process.stdout.write(
4  clc.columns([
5    [clc.bold("First Name"), clc.bold("Last Name"), clc.bold("Age")],
6    ["John", "Doe", 34],
7    ["Martha", "Smith", 20],
8    ["Jan", "Kowalski", 30]
9  ])
10);
11
12/* Outputs:
13
14First Name | Last Name | Age
15John       | Doe       | 34
16Martha     | Smith     | 20
17Jan        | Kowalski  | 30
18*/

throbber(write, interval[, format])

Writes throbber string to write function at given interval. Optionally throbber output can be formatted with given format function

1var setupThrobber = require("cli-color/throbber");
2
3var throbber = setupThrobber(function (str) { process.stdout.write(str); }, 200);
4
5throbber.start();
6
7// at any time you can stop/start throbber
8throbber.stop();

Tests

$ npm test

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Contributors

• @rentalhost (David Rodrigues)
  • Help with support for nested styles. Introduction of clc.art module, and significant improvements to tests coverage
• @StreetStrider
  • Implementation of sophistcated clc.slice functionality, and introduction of clc.getStrippedLength utility

---