ansi-colors

Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in replacement for chalk, kleur and turbocolor (without the dependencies and rendering bugs).

Please consider following this project's author, Brian Woodward, and consider starring the project to show your :heart: and support.

Install

Install with npm:

1$ npm install --save ansi-colors

Why use this?

ansi-colors is the fastest Node.js library for terminal styling. A more performant drop-in replacement for chalk, with no dependencies.

• Blazing fast - Fastest terminal styling library in node.js, 10-20x faster than chalk!

• Drop-in replacement for chalk.

• No dependencies (Chalk has 7 dependencies in its tree!)

• Safe - Does not modify the String.prototype like colors.

• Supports nested colors, and does not have the nested styling bug that is present in colorette, chalk, and kleur.

• Supports chained colors.

• Toggle color support on or off.

Usage

1const c = require('ansi-colors');
2
3console.log(c.red('This is a red string!'));
4console.log(c.green('This is a red string!'));
5console.log(c.cyan('This is a cyan string!'));
6console.log(c.yellow('This is a yellow string!'));

Chained colors

1console.log(c.bold.red('this is a bold red message'));
2console.log(c.bold.yellow.italic('this is a bold yellow italicized message'));
3console.log(c.green.bold.underline('this is a bold green underlined message'));

Nested colors

1console.log(c.yellow(`foo ${c.red.bold('red')} bar ${c.cyan('cyan')} baz`));

Nested styling bug

ansi-colors does not have the nested styling bug found in colorette, chalk, and kleur.

1const { bold, red } = require('ansi-styles');
2console.log(bold(`foo ${red.dim('bar')} baz`));
3
4const colorette = require('colorette');
5console.log(colorette.bold(`foo ${colorette.red(colorette.dim('bar'))} baz`));
6
7const kleur = require('kleur');
8console.log(kleur.bold(`foo ${kleur.red.dim('bar')} baz`));
9
10const chalk = require('chalk');
11console.log(chalk.bold(`foo ${chalk.red.dim('bar')} baz`));

Results in the following

(sans icons and labels)

Toggle color support

Easily enable/disable colors.

1const c = require('ansi-colors');
2
3// disable colors manually
4c.enabled = false;
5
6// or use a library to automatically detect support
7c.enabled = require('color-support').hasBasic;
8
9console.log(c.red('I will only be colored red if the terminal supports colors'));

Strip ANSI codes

Use the .unstyle method to strip ANSI codes from a string.

1console.log(c.unstyle(c.blue.bold('foo bar baz')));
2//=> 'foo bar baz'

Available styles

Note that bright and bright-background colors are not always supported.

(gray is the U.S. spelling, grey is more commonly used in the Canada and U.K.)

Style modifiers

• dim

• bold

• hidden

• italic

• underline

• inverse

• strikethrough

• reset

Aliases

Create custom aliases for styles.

1const colors = require('ansi-colors');
2
3colors.alias('primary', colors.yellow);
4colors.alias('secondary', colors.bold);
5
6console.log(colors.primary.secondary('Foo'));

Themes

A theme is an object of custom aliases.

1const colors = require('ansi-colors');
2
3colors.theme({
4  danger: colors.red,
5  dark: colors.dim.gray,
6  disabled: colors.gray,
7  em: colors.italic,
8  heading: colors.bold.underline,
9  info: colors.cyan,
10  muted: colors.dim,
11  primary: colors.blue,
12  strong: colors.bold,
13  success: colors.green,
14  underline: colors.underline,
15  warning: colors.yellow
16});
17
18// Now, we can use our custom styles alongside the built-in styles!
19console.log(colors.danger.strong.em('Error!'));
20console.log(colors.warning('Heads up!'));
21console.log(colors.info('Did you know...'));
22console.log(colors.success.bold('It worked!'));

Performance

Libraries tested

• ansi-colors v3.0.4
• chalk v2.4.1

Mac

MacBook Pro, Intel Core i7, 2.3 GHz, 16 GB.

Load time

Time it takes to load the first time require() is called:

• ansi-colors - 1.915ms
• chalk - 12.437ms

Benchmarks

# All Colors
  ansi-colors x 173,851 ops/sec ±0.42% (91 runs sampled)
  chalk x 9,944 ops/sec ±2.53% (81 runs sampled)))

# Chained colors
  ansi-colors x 20,791 ops/sec ±0.60% (88 runs sampled)
  chalk x 2,111 ops/sec ±2.34% (83 runs sampled)

# Nested colors
  ansi-colors x 59,304 ops/sec ±0.98% (92 runs sampled)
  chalk x 4,590 ops/sec ±2.08% (82 runs sampled)

Windows

Windows 10, Intel Core i7-7700k CPU @ 4.2 GHz, 32 GB

Load time

Time it takes to load the first time require() is called:

• ansi-colors - 1.494ms
• chalk - 11.523ms

Benchmarks

# All Colors
  ansi-colors x 193,088 ops/sec ±0.51% (95 runs sampled))
  chalk x 9,612 ops/sec ±3.31% (77 runs sampled)))

# Chained colors
  ansi-colors x 26,093 ops/sec ±1.13% (94 runs sampled)
  chalk x 2,267 ops/sec ±2.88% (80 runs sampled))

# Nested colors
  ansi-colors x 67,747 ops/sec ±0.49% (93 runs sampled)
  chalk x 4,446 ops/sec ±3.01% (82 runs sampled))

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• ansi-wrap: Create ansi colors by passing the open and close codes. | homepage
• strip-color: Strip ANSI color codes from a string. No dependencies. | homepage

Contributors

Author

Brian Woodward

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2019, Brian Woodward. Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on July 01, 2019.