chalk 0.5.0 → 1.1.1

package/index.js

@@ -5,20 +5,27 @@ var stripAnsi = require('strip-ansi');
 var hasAnsi = require('has-ansi');
 var supportsColor = require('supports-color');
 var defineProps = Object.defineProperties;
-var chalk = module.exports;
+var isSimpleWindowsTerm = process.platform === 'win32' && !/^xterm/i.test(process.env.TERM);
+
+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 (isSimpleWindowsTerm) {
+	ansiStyles.blue.open = '\u001b[94m';
+}
 
 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 () {
-				this._styles.push(key);
-				return this;
+				return build.call(this, this._styles.concat(key));
 			}
 		};
 	});
@@ -26,24 +33,63 @@ var styles = (function () {
 	return ret;
 })();
 
+var proto = defineProps(function chalk() {}, styles);
+
+function build(_styles) {
+	var builder = function () {
+		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.
+	/* eslint-disable no-proto */
+	builder.__proto__ = proto;
+
+	return builder;
+}
+
 function applyStyle() {
 	// support varags, but simply cast to string in case there's only one arg
-	var str = arguments.length === 1 ? String(arguments[0]) : [].slice.call(arguments).join(' ');
+	var args = arguments;
+	var argsLen = args.length;
+	var str = argsLen !== 0 && String(arguments[0]);
+
+	if (argsLen > 1) {
+		// don't slice `arguments`, it prevents v8 optimizations
+		for (var a = 1; a < argsLen; a++) {
+			str += ' ' + args[a];
+		}
+	}
 
-	if (!chalk.enabled || !str) {
+	if (!this.enabled || !str) {
 		return str;
 	}
 
-	var nestedStyles = applyStyle._styles;
+	var nestedStyles = this._styles;
+	var i = nestedStyles.length;
+
+	// Turns out that on Windows dimmed gray text becomes invisible in cmd.exe,
+	// see https://github.com/chalk/chalk/issues/58
+	// If we're on Windows and we're dealing with a gray color, temporarily make 'dim' a noop.
+	var originalDim = ansiStyles.dim.open;
+	if (isSimpleWindowsTerm && (nestedStyles.indexOf('gray') !== -1 || nestedStyles.indexOf('grey') !== -1)) {
+		ansiStyles.dim.open = '';
+	}
 
-	for (var i = 0; i < nestedStyles.length; i++) {
+	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
 		// will be colored, and the rest will simply be 'plain'.
 		str = code.open + str.replace(code.closeRe, code.open) + code.close;
 	}
 
+	// Reset the original 'dim' if we changed it to work around the Windows dimmed gray issue.
+	ansiStyles.dim.open = originalDim;
+
 	return str;
 }
 
@@ -51,11 +97,9 @@ function init() {
 	var ret = {};
 
 	Object.keys(styles).forEach(function (name) {
-		var style = defineProps(applyStyle, styles);
 		ret[name] = {
 			get: function () {
-				style._styles = [];
-				return style[name];
+				return build.call(this, [name]);
 			}
 		};
 	});
@@ -63,14 +107,10 @@ function init() {
 	return ret;
 }
 
-defineProps(chalk, init());
+defineProps(Chalk.prototype, init());
 
-chalk.styles = ansiStyles;
-chalk.hasColor = hasAnsi;
-chalk.stripColor = stripAnsi;
-chalk.supportsColor = supportsColor;
-
-// 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,19 +1,22 @@
 {
   "name": "chalk",
-  "version": "0.5.0",
-  "description": "Terminal string styling done right. Created because the `colors` module does some really horrible things.",
+  "version": "1.1.1",
+  "description": "Terminal string styling done right. Much color.",
   "license": "MIT",
-  "repository": "sindresorhus/chalk",
+  "repository": "chalk/chalk",
   "maintainers": [
-    "Sindre Sorhus <sindresorhus@gmail.com> (http://sindresorhus.com)",
-    "Joshua Appelman <joshua@jbna.nl>"
+    "Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)",
+    "Joshua Appelman <jappelman@xebia.com> (jbnicolai.com)",
+    "JD Ballard <i.am.qix@gmail.com> (github.com/qix-)"
   ],
   "engines": {
     "node": ">=0.10.0"
   },
   "scripts": {
-    "test": "mocha",
-    "bench": "matcha benchmark.js"
+    "test": "xo && mocha",
+    "bench": "matcha benchmark.js",
+    "coverage": "nyc npm test && nyc report",
+    "coveralls": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
   },
   "files": [
     "index.js"
@@ -26,7 +29,9 @@
     "console",
     "cli",
     "string",
+    "str",
     "ansi",
+    "style",
     "styles",
     "tty",
     "formatting",
@@ -40,14 +45,26 @@
     "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.1.0",
+    "escape-string-regexp": "^1.0.2",
+    "has-ansi": "^2.0.0",
+    "strip-ansi": "^3.0.0",
+    "supports-color": "^2.0.0"
   },
   "devDependencies": {
-    "matcha": "^0.5.0",
-    "mocha": "*"
+    "coveralls": "^2.11.2",
+    "matcha": "^0.6.0",
+    "mocha": "*",
+    "nyc": "^3.0.0",
+    "require-uncached": "^1.0.2",
+    "resolve-from": "^1.0.0",
+    "semver": "^4.3.3",
+    "xo": "*"
+  },
+  "xo": {
+    "envs": [
+      "node",
+      "mocha"
+    ]
   }
 }

package/readme.md

@@ -1,32 +1,41 @@
-# <img width="300" src="https://cdn.rawgit.com/sindresorhus/chalk/77ae94f63ab1ac61389b190e5a59866569d1a376/logo.svg" alt="chalk">
+<h1 align="center">
+	<br>
+	<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
 
-[![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/chalk/chalk.svg?branch=master)](https://travis-ci.org/chalk/chalk)
+[![Coverage Status](https://coveralls.io/repos/chalk/chalk/badge.svg?branch=master)](https://coveralls.io/r/chalk/chalk?branch=master)
+[![](http://img.shields.io/badge/unicorn-approved-ff69b4.svg)](https://www.youtube.com/watch?v=9auOCbH5Ns4)
 
-[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.**
 
-![screenshot](https://github.com/sindresorhus/ansi-styles/raw/master/screenshot.png)
+![](https://github.com/chalk/ansi-styles/raw/master/screenshot.png)
 
 
 ## 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 ~4500 modules](https://www.npmjs.com/browse/depended/chalk) as of July 15, 2015
 
 
 ## Install
 
-```sh
+```
 $ npm install --save chalk
 ```
 
@@ -39,22 +48,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 +93,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/chalk/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).
+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 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');
@@ -113,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.
 
@@ -135,7 +152,7 @@ if (!chalk.supportsColor) {
 
 ## Styles
 
-### General
+### Modifiers
 
 - `reset`
 - `bold`
@@ -146,13 +163,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 +187,27 @@ if (!chalk.supportsColor) {
 - `bgWhite`
 
 
+## 256-colors
+
+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
+
+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)