node package manager

ansistyles

ansistyles build status

Functions that surround a string with ansistyle codes so it prints in style.

In case you need colors, like red, have a look at ansicolors.

Installation

npm install ansistyles

Usage

var styles = require('ansistyles');
 
console.log(styles.bright('hello world'));    // prints hello world in 'bright' white 
console.log(styles.underline('hello world')); // prints hello world underlined 
console.log(styles.inverse('hello world'));   // prints hello world black on white 

Combining with ansicolors

Get the ansicolors module:

npm install ansicolors

var styles = require('ansistyles')
  , colors = require('ansicolors');
 
  console.log(
    // prints hello world underlined in blue on a green background 
    colors.bgGreen(colors.blue(styles.underline('hello world'))) 
  );

Tests

Look at the tests to see more examples and/or run them via:

npm explore ansistyles && npm test

More Styles

As you can see from here, more styles are available, but didn't have any effect on the terminals that I tested on Mac Lion and Ubuntu Linux.

I included them for completeness, but didn't show them in the examples because they seem to have no effect.

reset

A style reset function is also included, please note however that this is not nestable.

Therefore the below only underlines hell only, but not world.

console.log(styles.underline('hell' + styles.reset('o') + ' world'));

It is essentially the same as:

console.log(styles.underline('hell') + styles.reset('') + 'o world');

Alternatives

ansistyles tries to meet simple use cases with a very simple API. However, if you need a more powerful ansi formatting tool, I'd suggest to look at the features of the ansi module.

Use this within your firewall

Combine open-source packages with your private code and publish to a private registry behind the firewall. npm ♥ enterprise developers

how? learn more

Collaborators list

Stats

Try it out

Keywords

ansi, style, terminal, console

Dependencies

None

Dependents (41)

@mrauhu/npm, npmc, cdoak, aaaaaserver, wedmaster, optimist-config-file, npm, bunyan-formatter, jhaynie-bunyan-format, simplay, jmpr-jpm, rosehip, replpad, ynztyl10_phantomas, omegapm, npmdiff, npm-for-cnpm, npm2, bug-me, tj-npm, trap, npm-beta, pagetimeline, pageinsight, npm-msys2, yapm, hermit, naver-npm, npm-2, caterpillar-human, nativescript-contacts-picker, bunyan-format, bunyan-format-bq, phantomas, scoped-logger, sabers, server-liuxinru, npm5, yss-perseus, and more