chalk
Terminal string styling done right.
colors.js is currently the most popular coloring module, but it has serious deficiencies like extending String.prototype which causes all kinds of problems. Although there are other ones, they either do too much or not enough.
Chalk is a clean and focused alternative.
Why
- Doesn't extend String.prototype
- Expressive API
- Auto-detects color support
- Actively maintained
Install
Install with npm: npm install --save chalk
Example
Chalk comes with an easy to use composable API where you just chain the styles you want.
var chalk = require('chalk');
console.log(chalk.blue('Hello world!'));
console.log(chalk.blue('Hello') + 'World' + chalk.red('!'));
console.log(chalk.blue.bgRed.bold('Hello world!'));
You can easily define your own themes.
var chalk = require('chalk');
var error = chalk.bold.red;
console.log(error('Error!'));
API
chalk.<style>[.<style>...](string)
Chain styles and call the last one as a method with a string argument.
chalk.enabled
Color support is automatically detected, but you can override it.
chalk.supportsColor
Detect whether the terminal supports color.
Can be overridden by the user with the flags --color
and --no-color
.
Used internally and handled for you, but exposed for convenience.
chalk.styles
Exposes the styles as ANSI escape codes.
var chalk = require('chalk');
console.log(chalk.styles.red);
chalk.stripColor(string)
Strip color from a string.
Styles
General
- reset
- bold
- italic
- underline
- blink
- inverse
- strikethrough
Text colors
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- default
- gray
Background colors
- bgBlack
- bgRed
- bgGreen
- bgYellow
- bgBlue
- bgMagenta
- bgCyan
- bgWhite
- bgDefault
License
MIT License • © Sindre Sorhus