chalk 0.5.1 → 1.0.0

package/index.js

@@ -5,13 +5,23 @@ var stripAnsi = require('strip-ansi');
 var hasAnsi = require('has-ansi');
 var supportsColor = require('supports-color');
 var defineProps = Object.defineProperties;
-var chalk = module.exports;
+
+function Chalk(options) {
+	// detect mode if not set manually
+	this.enabled = !options || options.enabled === undefined ? supportsColor : options.enabled;
+}
+
+// use bright blue on Windows as the normal blue color is illegible
+if (process.platform === 'win32') {
+	ansiStyles.blue.open = '\u001b[94m';
+}
 
 function build(_styles) {
 	var builder = function builder() {
 		return applyStyle.apply(builder, arguments);
 	};
 	builder._styles = _styles;
+	builder.enabled = this.enabled;
 	// __proto__ is used because we must return a function, but there is
 	// no way to create a function with a different prototype.
 	builder.__proto__ = proto;
@@ -21,14 +31,12 @@ function build(_styles) {
 var styles = (function () {
 	var ret = {};
 
-	ansiStyles.grey = ansiStyles.gray;
-
 	Object.keys(ansiStyles).forEach(function (key) {
 		ansiStyles[key].closeRe = new RegExp(escapeStringRegexp(ansiStyles[key].close), 'g');
 
 		ret[key] = {
 			get: function () {
-				return build(this._styles.concat(key));
+				return build.call(this, this._styles.concat(key));
 			}
 		};
 	});
@@ -50,14 +58,15 @@ function applyStyle() {
 		}
 	}
 
-	if (!chalk.enabled || !str) {
+	if (!this.enabled || !str) {
 		return str;
 	}
 
-	/*jshint validthis: true*/
+	/*jshint validthis: true */
 	var nestedStyles = this._styles;
 
-	for (var i = 0; i < nestedStyles.length; i++) {
+	var i = nestedStyles.length;
+	while (i--) {
 		var code = ansiStyles[nestedStyles[i]];
 		// Replace any instances already present with a re-opening code
 		// otherwise only the part of the string until said closing code
@@ -74,7 +83,7 @@ function init() {
 	Object.keys(styles).forEach(function (name) {
 		ret[name] = {
 			get: function () {
-				return build([name]);
+				return build.call(this, [name]);
 			}
 		};
 	});
@@ -82,14 +91,10 @@ function init() {
 	return ret;
 }
 
-defineProps(chalk, init());
-
-chalk.styles = ansiStyles;
-chalk.hasColor = hasAnsi;
-chalk.stripColor = stripAnsi;
-chalk.supportsColor = supportsColor;
+defineProps(Chalk.prototype, init());
 
-// detect mode if not set manually
-if (chalk.enabled === undefined) {
-	chalk.enabled = chalk.supportsColor;
-}
+module.exports = new Chalk();
+module.exports.styles = ansiStyles;
+module.exports.hasColor = hasAnsi;
+module.exports.stripColor = stripAnsi;
+module.exports.supportsColor = supportsColor;

package/license

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "chalk",
-  "version": "0.5.1",
-  "description": "Terminal string styling done right. Created because the `colors` module does some really horrible things.",
+  "version": "1.0.0",
+  "description": "Terminal string styling done right. Much color.",
   "license": "MIT",
   "repository": "sindresorhus/chalk",
   "maintainers": [
     "Sindre Sorhus <sindresorhus@gmail.com> (http://sindresorhus.com)",
-    "Joshua Appelman <joshua@jbna.nl>"
+    "Joshua Appelman <jappelman@xebia.com> (http://jbnicolai.com)"
   ],
   "engines": {
     "node": ">=0.10.0"
@@ -40,14 +40,14 @@
     "text"
   ],
   "dependencies": {
-    "ansi-styles": "^1.1.0",
-    "escape-string-regexp": "^1.0.0",
-    "has-ansi": "^0.1.0",
-    "strip-ansi": "^0.3.0",
-    "supports-color": "^0.2.0"
+    "ansi-styles": "^2.0.1",
+    "escape-string-regexp": "^1.0.2",
+    "has-ansi": "^1.0.3",
+    "strip-ansi": "^2.0.1",
+    "supports-color": "^1.3.0"
   },
   "devDependencies": {
-    "matcha": "^0.5.0",
+    "matcha": "^0.6.0",
     "mocha": "*"
   }
 }

package/readme.md

@@ -1,11 +1,15 @@
-# <img width="300" src="https://cdn.rawgit.com/sindresorhus/chalk/77ae94f63ab1ac61389b190e5a59866569d1a376/logo.svg" alt="chalk">
+<h1 align="center">
+	<br>
+	<img width="360" src="https://cdn.rawgit.com/sindresorhus/chalk/19935d6484811c5e468817f846b7b3d417d7bf4a/logo.svg" alt="chalk">
+	<br>
+	<br>
+</h1>
 
 > Terminal string styling done right
 
-[![Build Status](https://travis-ci.org/sindresorhus/chalk.svg?branch=master)](https://travis-ci.org/sindresorhus/chalk)
-![](http://img.shields.io/badge/unicorn-approved-ff69b4.svg)
+[![Build Status](https://travis-ci.org/sindresorhus/chalk.svg?branch=master)](https://travis-ci.org/sindresorhus/chalk) [![](http://img.shields.io/badge/unicorn-approved-ff69b4.svg?style=flat)](https://www.youtube.com/watch?v=Sm368W0OsHo)
 
-[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](https://github.com/yeoman/yo/issues/68). Although there are other ones, they either do too much or not enough.
+[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.**
 
@@ -15,18 +19,18 @@
 ## Why
 
 - Highly performant
-- Doesn't extend String.prototype
+- Doesn't extend `String.prototype`
 - Expressive API
 - Ability to nest styles
 - Clean and focused
 - Auto-detects color support
 - Actively maintained
-- [Used by 1000+ modules](https://npmjs.org/browse/depended/chalk)
+- [Used by ~3000 modules](https://www.npmjs.com/browse/depended/chalk)
 
 
 ## Install
 
-```sh
+```
 $ npm install --save chalk
 ```
 
@@ -39,22 +43,26 @@ Chalk comes with an easy to use composable API where you just chain and nest the
 var chalk = require('chalk');
 
 // style a string
-console.log(  chalk.blue('Hello world!')  );
+chalk.blue('Hello world!');
 
 // combine styled and normal strings
-console.log(  chalk.blue('Hello'), 'World' + chalk.red('!')  );
+chalk.blue('Hello') + 'World' + chalk.red('!');
 
 // compose multiple styles using the chainable API
-console.log(  chalk.blue.bgRed.bold('Hello world!')  );
+chalk.blue.bgRed.bold('Hello world!');
 
 // pass in multiple arguments
-console.log(  chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')  );
+chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz');
 
 // nest styles
-console.log(  chalk.red('Hello', chalk.underline.bgBlue('world') + '!')  );
+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!')  );
+chalk.green(
+	'I am a green line ' +
+	chalk.blue.underline.bold('with a blue substring') +
+	' that becomes green again!'
+);
 ```
 
 Easily define your own themes.
@@ -80,27 +88,31 @@ console.log(chalk.green('Hello %s'), name);
 
 Example: `chalk.red.bold.underline('Hello', 'world');`
 
-Chain [styles](#styles) and call the last one as a method with a string argument. Order doesn't matter.
+Chain [styles](#styles) and call the last one as a method with a string argument. Order doesn't matter, and later styles take precedent in case of a conflict. This simply means that `Chalk.red.yellow.green` is equivalent to `Chalk.green`.
 
 Multiple arguments will be separated by space.
 
 ### chalk.enabled
 
-Color support is automatically detected, but you can override it.
+Color support is automatically detected, but you can override it by setting the `enabled` property. You should however only do this in your own code as it applies globally to all chalk consumers.
 
-### chalk.supportsColor
+If you need to change this in a reusable module create a new instance:
+
+```js
+var ctx = new chalk.constructor({enabled: false});
+```
 
-Detect whether the terminal [supports color](https://github.com/sindresorhus/supports-color).
+### chalk.supportsColor
 
-Can be overridden by the user with the flags `--color` and `--no-color`.
+Detect whether the terminal [supports color](https://github.com/sindresorhus/supports-color). Used internally and handled for you, but exposed for convenience.
 
-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).
 
-Generally not useful, but you might need just the `.open` or `.close` escape code if you're mixing externally styled strings with yours.
+Generally not useful, but you might need just the `.open` or `.close` escape code if you're mixing externally styled strings with your own.
 
 ```js
 var chalk = require('chalk');
@@ -135,7 +147,7 @@ if (!chalk.supportsColor) {
 
 ## Styles
 
-### General
+### Modifiers
 
 - `reset`
 - `bold`
@@ -146,13 +158,13 @@ if (!chalk.supportsColor) {
 - `hidden`
 - `strikethrough` *(not widely supported)*
 
-### Text colors
+### Colors
 
 - `black`
 - `red`
 - `green`
 - `yellow`
-- `blue`
+- `blue` *(on Windows the bright version is used as normal blue is illegible)*
 - `magenta`
 - `cyan`
 - `white`
@@ -170,6 +182,16 @@ if (!chalk.supportsColor) {
 - `bgWhite`
 
 
+## 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.
+
+
+## Windows
+
+If you're on Windows, do yourself a favor and use [`cmder`](http://bliker.github.io/cmder/) instead of `cmd.exe`.
+
+
 ## License
 
 MIT © [Sindre Sorhus](http://sindresorhus.com)