diff options
Diffstat (limited to 'tools/eslint/node_modules/chalk/readme.md')
| -rw-r--r-- | tools/eslint/node_modules/chalk/readme.md | 34 |
1 files changed, 25 insertions, 9 deletions
diff --git a/tools/eslint/node_modules/chalk/readme.md b/tools/eslint/node_modules/chalk/readme.md index 43c7064335..5cf111e353 100644 --- a/tools/eslint/node_modules/chalk/readme.md +++ b/tools/eslint/node_modules/chalk/readme.md @@ -1,19 +1,24 @@ <h1 align="center"> <br> - <img width="360" src="https://cdn.rawgit.com/sindresorhus/chalk/19935d6484811c5e468817f846b7b3d417d7bf4a/logo.svg" alt="chalk"> + <br> + <img width="360" src="https://cdn.rawgit.com/chalk/chalk/19935d6484811c5e468817f846b7b3d417d7bf4a/logo.svg" alt="chalk"> + <br> <br> <br> </h1> > Terminal string styling done right -[](https://travis-ci.org/sindresorhus/chalk) [](https://www.youtube.com/watch?v=Sm368W0OsHo) +[](https://travis-ci.org/chalk/chalk) +[](https://coveralls.io/r/chalk/chalk?branch=master) +[](https://www.youtube.com/watch?v=9auOCbH5Ns4) + [colors.js](https://github.com/Marak/colors.js) used to be the most popular string styling module, but it has serious deficiencies like extending `String.prototype` which causes all kinds of [problems](https://github.com/yeoman/yo/issues/68). Although there are other ones, they either do too much or not enough. **Chalk is a clean and focused alternative.** - + ## Why @@ -25,7 +30,7 @@ - Clean and focused - Auto-detects color support - Actively maintained -- [Used by ~3000 modules](https://www.npmjs.com/browse/depended/chalk) +- [Used by ~4500 modules](https://www.npmjs.com/browse/depended/chalk) as of July 15, 2015 ## Install @@ -104,13 +109,13 @@ var ctx = new chalk.constructor({enabled: false}); ### chalk.supportsColor -Detect whether the terminal [supports color](https://github.com/sindresorhus/supports-color). Used internally and handled for you, but exposed for convenience. +Detect whether the terminal [supports color](https://github.com/chalk/supports-color). Used internally and handled for you, but exposed for convenience. Can be overridden by the user with the flags `--color` and `--no-color`. For situations where using `--color` is not possible, add an environment variable `FORCE_COLOR` with any value to force color. Trumps `--no-color`. ### chalk.styles -Exposes the styles as [ANSI escape codes](https://github.com/sindresorhus/ansi-styles). +Exposes the styles as [ANSI escape codes](https://github.com/chalk/ansi-styles). Generally not useful, but you might need just the `.open` or `.close` escape code if you're mixing externally styled strings with your own. @@ -125,11 +130,11 @@ console.log(chalk.styles.red.open + 'Hello' + chalk.styles.red.close); ### chalk.hasColor(string) -Check whether a string [has color](https://github.com/sindresorhus/has-ansi). +Check whether a string [has color](https://github.com/chalk/has-ansi). ### chalk.stripColor(string) -[Strip color](https://github.com/sindresorhus/strip-ansi) from a string. +[Strip color](https://github.com/chalk/strip-ansi) from a string. Can be useful in combination with `.supportsColor` to strip color on externally styled text when it's not supported. @@ -184,7 +189,7 @@ if (!chalk.supportsColor) { ## 256-colors -Chalk does not support support anything other than the base eight colors, which guarantees it will work on all terminals and systems. Some terminals, specifically `xterm` compliant ones, will support the full range of 8-bit colors. For this the lower level [ansi-256-colors](https://github.com/jbnicolai/ansi-256-colors) package can be used. +Chalk does not support anything other than the base eight colors, which guarantees it will work on all terminals and systems. Some terminals, specifically `xterm` compliant ones, will support the full range of 8-bit colors. For this the lower level [ansi-256-colors](https://github.com/jbnicolai/ansi-256-colors) package can be used. ## Windows @@ -192,6 +197,17 @@ Chalk does not support support anything other than the base eight colors, which If you're on Windows, do yourself a favor and use [`cmder`](http://bliker.github.io/cmder/) instead of `cmd.exe`. +## Related + +- [chalk-cli](https://github.com/chalk/chalk-cli) - CLI for this module +- [ansi-styles](https://github.com/chalk/ansi-styles/) - ANSI escape codes for styling strings in the terminal +- [supports-color](https://github.com/chalk/supports-color/) - Detect whether a terminal supports color +- [strip-ansi](https://github.com/chalk/strip-ansi) - Strip ANSI escape codes +- [has-ansi](https://github.com/chalk/has-ansi) - Check if a string has ANSI escape codes +- [ansi-regex](https://github.com/chalk/ansi-regex) - Regular expression for matching ANSI escape codes +- [wrap-ansi](https://github.com/chalk/wrap-ansi) - Wordwrap a string with ANSI escape codes + + ## License MIT © [Sindre Sorhus](http://sindresorhus.com) |