b0523a4438
- Precomputed style function
- Skip arguments to array + join if there's only one argument (the
common case)
- Merge multiple return statements to one
To calculate the performance benefit:
```javascript
var chalk = require('./index.js');
console.time('100000 iterations');
for (var i = 0; i < 100000; i++) {
chalk.red('A string that is about 80 characters long (normal use I think?)');
}
console.timeEnd('100000 iterations');
```
Running this before this commit:
```shell
for i in {1..5}; do node time.js; done
100000 iterations: 19485ms
100000 iterations: 18933ms
100000 iterations: 19365ms
100000 iterations: 19332ms
100000 iterations: 18660ms
```
After:
```shell
100000 iterations: 268ms
100000 iterations: 261ms
100000 iterations: 264ms
100000 iterations: 259ms
100000 iterations: 254ms
```
Performance gain, taking the middle result of both:
```shell
19332 / 261 = 74.~
```
Closes #16
|
||
|---|---|---|
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .jshintrc | ||
| .travis.yml | ||
| index.js | ||
| license | ||
| logo.png | ||
| logo.svg | ||
| package.json | ||
| readme.md | ||
| test.js | ||
Terminal string styling done right
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
- Ability to nest styles
- Clean and focused
- Auto-detects color support
- Actively maintained
- Used by 1000+ modules
Install
$ npm install --save chalk
Usage
Chalk comes with an easy to use composable API where you just chain and nest the styles you want.
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!') );
// pass in multiple arguments
console.log( chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz') );
// nest styles
console.log( chalk.red('Hello', chalk.underline.bgBlue('world') + '!') );
// nest styles of the same type even (color, underline, background)
console.log( chalk.green('I am a green line ' + chalk.blue('with a blue substring') + ' that becomes green again!') );
Easily define your own themes.
var chalk = require('chalk');
var error = chalk.bold.red;
console.log(error('Error!'));
Take advantage of console.log string substitution.
var name = 'Sindre';
console.log(chalk.green('Hello %s'), name);
//=> Hello Sindre
API
chalk.<style>[.<style>...](string, [string...])
Example: chalk.red.bold.underline('Hello', 'world');
Chain styles and call the last one as a method with a string argument. Order doesn't matter.
Multiple arguments will be separated by space.
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.
Generally not useful, but you might need just the .open or .close escape code if you're mixing externally styled strings with yours.
var chalk = require('chalk');
console.log(chalk.styles.red);
//=> {open: '\u001b[31m', close: '\u001b[39m'}
console.log(chalk.styles.red.open + 'Hello' + chalk.styles.red.close);
chalk.stripColor(string)
Strip color from a string.
Can be useful in combination with .supportsColor to strip color on externally styled text when it's not supported.
Example:
var chalk = require('chalk');
var styledString = getText();
if (!chalk.supportsColor) {
styledString = chalk.stripColor(styledString);
}
Styles
General
resetbolddimitalic(not widely supported)underlineinversehiddenstrikethrough(not widely supported)
Text colors
blackredgreenyellowbluemagentacyanwhitegray
Background colors
bgBlackbgRedbgGreenbgYellowbgBluebgMagentabgCyanbgWhite
License
MIT © Sindre Sorhus