ansis

ANSI Styling

---

Color styling of text for ANSI terminals using the SGR (Select Graphic Rendition) codes defined in the ECMA-48 standard.
This is improved and faster implementation for Node.js.

Install

npm install ansis --save-dev

Show ANSI demo

npm run demo

Quick start

import ansis from 'ansis';

console.log(ansis.green(`Hello ${ansis.inverse('ANSI')} World!`));
console.log(ansis.black.bgYellow(`Warning: `) + ansis.cyan(' /path/to/file.js ') + ansis.red(`not found!`) );

Output:

Features

• supports ES modules, 100% vanilla JavaScript, compact code, no dependencies
• powerful and lightweight library is faster than many others such as chalk kleur ansi-colors etc.
• supports the standard de facto API of the chalk
• supports 256 color and Truecolor
• supports styles like: bold red yellowBright bgGreen bgCyanBright ect.
• supports chained styles, e.g.:

  ansis.red.bold.italic.underline('text');
  

• supports nested styles like colorette picocolors, e.g.:

  const c = ansis;
  c.red(`red ${c.italic.green('italic green')} red`);
  c.red(`${c.bold(`${c.italic(`${c.underline('underline')}italic`)}bold`)}red`);
  

• supports methods for custom colors rgb() hex() bgRgb() bgHex() ansi256() bgAnsi256():

  ansis.rgb(255, 80, 200)('text');
  ansis.hex('#FF88AA')('text');
  ansis.bgHex('#F8A')('text');
  ansis.ansi256(110)('text');
  

• supports shortcut, e.g.:

  const theme = {
    error: ansis.red.bold,
    info: ansis.cyan.italic,
    warning: ansis.bgYellowBright,
    ruby: ansis.hex('#E0115F'),
    bgAmber: ansis.bgHex('#FFBF00'),
  };
  
  theme.error('error');
  theme.info('info');
  theme.warning('warning');
  theme.ruby('Ruby color');
  theme.bgAmber('Amber background color');
  

• supports the use of open and close properties for each style, e.g.:

  const myStyle = ansis.bold.italic.black.bgHex('#ABCDEF');
  console.log(`Hello ${ansis.green.open}ANSI${ansis.green.close} World!`);
  console.log(`Hello ${myStyle.open}ANSI${myStyle.close} World!`);
  

• supports correct break of style at end of line, e.g.:

  ansis.bgGreen(`\nAnsis\nNew Line\nNext New Line\n`);
  

Styles

reset inverse hidden visible bold dim(aliasfaint) italic underline doubleUnderline overline strikethrough(alias strike) frame encircle

Foreground colors

black red green blue magenta cyan white gray blackBright redBright greenBright yellowBright blueBright magentaBright cyanBright whiteBright

Background colors

bgBlack bgRed bgGreen bgYellow bgBlue bgMagenta bgCyan bgWhite bgGray bgBlackBright bgRedBright bgGreenBright bgYellowBright bgBlueBright bgMagentaBright bgCyanBright bgWhiteBright

256 ANSI colors

See ANSI color codes.

// foreground color
ansis.ansi256(96).bold('bold Bright Cyan');
// background color
ansis.bgAnsi256(105)('Bright Magenta');

Truecolor

// foreground color
ansis.hex('#E0115F').bold('bold Ruby');
ansis.hex('#96C')('Amethyst');
ansis.rgb(224, 17, 95).italic.underline('italic underline Ruby');

// background color
ansis.bgHex('#E0115F')('Ruby');
ansis.bgHex('#96C')('Amethyst');
ansis.bgRgb(224, 17, 95)('Ruby');

Benchmark

Initialize

cd ./bench
npm i

Start benchmark

npm run bench

Tested on

MacBook Pro 16" M1 Max 64GB
macOS Monterey 12.1
Node.js v16.13.1
Terminal iTerm2

Colorette bench

The benchmark used in colorette.

c.red(`${c.bold(`${c.cyan(`${c.yellow('yellow')}cyan`)}`)}red`);

  colors-js           1,119,016 ops/sec
  colorette           4,537,603 ops/sec
  picocolors          3,818,885 ops/sec
  cli-color             470,921 ops/sec
  color-cli             109,666 ops/sec
  ansi-colors         1,267,504 ops/sec
  kleur/colors        2,265,820 ops/sec
  kleur               2,216,547 ops/sec
  chalk               2,272,601 ops/sec
+ ansis               1,910,873 ops/sec

Base styles

styles.forEach((style) => c[style]('foo'));

  colors-js             462,720 ops/sec
  colorette           1,492,260 ops/sec
  picocolors          5,736,444 ops/sec
  cli-color             222,377 ops/sec
  color-cli              73,354 ops/sec
  ansi-colors           719,913 ops/sec
  kleur/colors        1,446,799 ops/sec
  kleur               3,822,845 ops/sec
  chalk               3,151,919 ops/sec
+ ansis               4,248,414 ops/sec

Chained styles

colors.forEach((color) => c[color].bold.underline.italic('foo'));

  colors-js             136,976 ops/sec
  colorette             (not supported)
  picocolors            (not supported)
  cli-color             142,024 ops/sec
  color-cli              52,604 ops/sec
  ansi-colors           159,209 ops/sec
  kleur/colors          (not supported)
  kleur                 511,077 ops/sec
  chalk               1,613,521 ops/sec
+ ansis               5,126,060 ops/sec

Nested calls

colors.forEach((color) => c[color](c.bold(c.underline(c.italic('foo')))));

  colors-js             165,526 ops/sec
  colorette             750,531 ops/sec
  picocolors            940,217 ops/sec
  cli-color              64,927 ops/sec
  color-cli              13,764 ops/sec
  ansi-colors           258,639 ops/sec
  kleur/colors          566,145 ops/sec
  kleur                 645,191 ops/sec
  chalk                 493,049 ops/sec
+ ansis                 354,148 ops/sec

Nested styles

c.red(`a red ${c.white('white')} red ${c.red('red')} red ${c.cyan('cyan')} red ${c.black('black')} red ${c.red('red')} red ${c.green('green')} red ${c.red('red')} red ${c.yellow('yellow')} red ${c.blue('blue')} red ${c.red('red')} red ${c.magenta('magenta')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.green('green')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.magenta('magenta')} red ${c.red('red')} red ${c.red('red')} red ${c.cyan('cyan')} red ${c.red('red')} red ${c.red('red')} red ${c.yellow('yellow')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} red ${c.red('red')} message`);

  colors-js              91,036 ops/sec
  colorette             247,359 ops/sec
  picocolors            246,168 ops/sec
  cli-color              42,756 ops/sec
  color-cli              14,343 ops/sec
  ansi-colors           122,972 ops/sec
  kleur/colors          241,366 ops/sec
  kleur                 228,477 ops/sec
  chalk                 195,446 ops/sec
+ ansis                 210,382 ops/sec

HEX colors

Only two libraries support truecolors methods: ansis and chalk

c.hex('#FBA')('foo');

  colors-js             (not supported)
  colorette             (not supported)
  picocolors            (not supported)
  cli-color             (not supported)
  color-cli             (not supported)
  ansi-colors           (not supported)
  kleur/colors          (not supported)
  kleur                 (not supported)
  chalk               2,935,616 ops/sec
+ ansis               4,612,085 ops/sec

Testing

npm run test will run the unit and integration tests.
npm run test:coverage will run the tests with coverage.

Also See

Most popular ANSI libraries for Node.js:

• colors.js
• colorette
• picocolors
• cli-color
• color-cli
• ansi-colors
• kleur
• chalk

License

ISC

Changelog

1.1.0 (2021-12-25)

• feat: add supports the use of open and close properties for each style
• fix: codes for methods ansi256() and bgAnsi256()
• chore: added demo to npm package
• chore: update package.json
• docs: update readme