https://github.com/ngot/ansicolors

Functions for fibjs that surround a string with ansicolor codes so it prints in color.
https://github.com/ngot/ansicolors

Last synced: about 1 month ago
JSON representation

Functions for fibjs that surround a string with ansicolor codes so it prints in color.

• Host: GitHub
• URL: https://github.com/ngot/ansicolors
• Owner: ngot
• License: mit
• Created: 2014-07-13T06:11:07.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-13T06:11:37.000Z (over 10 years ago)
• Last Synced: 2024-10-16T21:26:54.844Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 121 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#ansicolors 

###modified from [ansistyles](https://github.com/thlorenz/ansicolors).

Functions that surround a string with ansicolor codes so it prints in color.

In case you need styles, like `bold`, have a look at [ansistyles](https://github.com/ngot/ansicolors.git).

```js

var colors = require('ansicolors');

// foreground colors

var redHerring = colors.red('herring');

var blueMoon = colors.blue('moon');

var brighBlueMoon = colors.brightBlue('moon');

console.log(redHerring);      // this will print 'herring' in red

console.log(blueMoon);        // this 'moon' in blue

console.log(brightBlueMoon);  // I think you got the idea

// background colors

console.log(colors.bgYellow('printed on yellow background'));

console.log(colors.bgBrightBlue('printed on bright blue background'));

// mixing background and foreground colors

// below two lines have same result (order in which bg and fg are combined doesn't matter)

console.log(colors.bgYellow(colors.blue('printed on yellow background in blue')));

console.log(colors.blue(colors.bgYellow('printed on yellow background in blue')));

```

## Advanced API

**ansicolors** allows you to access opening and closing escape sequences separately.

```js

var colors = require('ansicolors');

function inspect(obj, depth) {

  return require('utiljs').inspect(obj, false, depth || 5, true);

}

console.log('open blue', inspect(colors.open.blue));

console.log('close bgBlack', inspect(colors.close.bgBlack));

// => open blue '\u001b[34m'

//    close bgBlack '\u001b[49m'

```

## Tests

Look at the [tests](https://github.com/ngot/ansicolors/blob/master/test/ansicolors.js) to see more examples and/or run them via: 

    js test/ansicolors.js

## Alternatives

**ansicolors** tries to meet simple use cases with a very simple API. However, if you need a more powerful ansi formatting tool,