135 lines
2.8 KiB
Markdown
135 lines
2.8 KiB
Markdown
# <img width="250" src="logo.png" alt="chalk">
|
|
|
|
> Terminal string styling done right.
|
|
|
|
[](http://travis-ci.org/sindresorhus/chalk)
|
|
|
|
[colors.js](https://github.com/Marak/colors.js) is currently the most popular string styling 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
|
|
- Clean and focused
|
|
- Auto-detects color support
|
|
- Actively maintained
|
|
|
|
|
|
## Install
|
|
|
|
Install with [npm](https://npmjs.org/package/chalk): `npm install --save chalk`
|
|
|
|
|
|
## Example
|
|
|
|
Chalk comes with an easy to use composable API where you just chain the styles you want.
|
|
|
|
```js
|
|
var chalk = require('chalk');
|
|
|
|
// style a string
|
|
console.log(chalk.blue('Hello world!'));
|
|
|
|
// combine styled and normal strings
|
|
console.log(chalk.blue('Hello'), 'World' + chalk.red('!'));
|
|
|
|
// compose multiple styles using the chainable API
|
|
console.log(chalk.blue.bgRed.bold('Hello world!'));
|
|
|
|
// nest styles
|
|
chalk.red('Hello', chalk.underline.bgBlue('world') + '!');
|
|
|
|
// pass in multiple arguments
|
|
console.log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz'));
|
|
```
|
|
|
|
You can easily define your own themes.
|
|
|
|
```js
|
|
var chalk = require('chalk');
|
|
var error = chalk.bold.red;
|
|
console.log(error('Error!'));
|
|
```
|
|
|
|
|
|
## API
|
|
|
|
### chalk.`<style>[.<style>...](string, [string...])`
|
|
|
|
Chain [styles](#styles) and call the last one as a method with a string argument.
|
|
|
|
Multiple arguments are also supported. Chalk will add a space between each one.
|
|
|
|
### chalk.enabled
|
|
|
|
Color support is automatically detected, but you can override it.
|
|
|
|
### chalk.supportsColor
|
|
|
|
Detect whether the terminal [supports color](https://github.com/sindresorhus/has-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](https://github.com/sindresorhus/ansi-styles).
|
|
|
|
```js
|
|
var chalk = require('chalk');
|
|
|
|
console.log(chalk.styles.red);
|
|
//=> {open: '\x1b[31m', close: '\x1b[39m'}
|
|
|
|
console.log(chalk.styles.red.open + 'Hello' + chalk.styles.red.close);
|
|
```
|
|
|
|
### chalk.stripColor(string)
|
|
|
|
[Strip color](https://github.com/sindresorhus/strip-ansi) from a string.
|
|
|
|
|
|
## Styles
|
|
|
|
### General
|
|
|
|
- reset
|
|
- bold
|
|
- italic
|
|
- underline
|
|
- inverse
|
|
- strikethrough
|
|
|
|
### Text colors
|
|
|
|
- black
|
|
- red
|
|
- green
|
|
- yellow
|
|
- blue
|
|
- magenta
|
|
- cyan
|
|
- white
|
|
- gray
|
|
|
|
### Background colors
|
|
|
|
- bgBlack
|
|
- bgRed
|
|
- bgGreen
|
|
- bgYellow
|
|
- bgBlue
|
|
- bgMagenta
|
|
- bgCyan
|
|
- bgWhite
|
|
|
|
|
|
## License
|
|
|
|
MIT © [Sindre Sorhus](http://sindresorhus.com)
|