chalk 0.3.0 → 1.0.0

package/index.js

@@ -0,0 +1,100 @@
+'use strict';
+var escapeStringRegexp = require('escape-string-regexp');
+var ansiStyles = require('ansi-styles');
+var stripAnsi = require('strip-ansi');
+var hasAnsi = require('has-ansi');
+var supportsColor = require('supports-color');
+var defineProps = Object.defineProperties;
+
+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;
+	return builder;
+}
+
+var styles = (function () {
+	var ret = {};
+
+	Object.keys(ansiStyles).forEach(function (key) {
+		ansiStyles[key].closeRe = new RegExp(escapeStringRegexp(ansiStyles[key].close), 'g');
+
+		ret[key] = {
+			get: function () {
+				return build.call(this, this._styles.concat(key));
+			}
+		};
+	});
+
+	return ret;
+})();
+
+var proto = defineProps(function chalk() {}, styles);
+
+function applyStyle() {
+	// support varags, but simply cast to string in case there's only one arg
+	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 (!this.enabled || !str) {
+		return str;
+	}
+
+	/*jshint validthis: true */
+	var nestedStyles = this._styles;
+
+	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
+		// will be colored, and the rest will simply be 'plain'.
+		str = code.open + str.replace(code.closeRe, code.open) + code.close;
+	}
+
+	return str;
+}
+
+function init() {
+	var ret = {};
+
+	Object.keys(styles).forEach(function (name) {
+		ret[name] = {
+			get: function () {
+				return build.call(this, [name]);
+			}
+		};
+	});
+
+	return ret;
+}
+
+defineProps(Chalk.prototype, init());
+
+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,7 +1,23 @@
 {
   "name": "chalk",
-  "version": "0.3.0",
-  "description": "Terminal string styling done right",
+  "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 <jappelman@xebia.com> (http://jbnicolai.com)"
+  ],
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "test": "mocha",
+    "bench": "matcha benchmark.js"
+  },
+  "files": [
+    "index.js"
+  ],
   "keywords": [
     "color",
     "colour",
@@ -23,33 +39,15 @@
     "command-line",
     "text"
   ],
-  "homepage": "https://github.com/sindresorhus/chalk",
-  "bugs": "https://github.com/sindresorhus/chalk/issues",
-  "license": "MIT",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "http://sindresorhus.com"
-  },
-  "files": [
-    "chalk.js"
-  ],
-  "main": "chalk",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/sindresorhus/chalk.git"
-  },
-  "scripts": {
-    "test": "mocha"
-  },
   "dependencies": {
-    "has-color": "~0.1.0",
-    "ansi-styles": "~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": {
-    "mocha": "~1.12.0"
-  },
-  "engines": {
-    "node": ">=0.8.0"
+    "matcha": "^0.6.0",
+    "mocha": "*"
   }
 }

package/readme.md

@@ -1,52 +1,71 @@
-# chalk [![Build Status](https://secure.travis-ci.org/sindresorhus/chalk.png?branch=master)](http://travis-ci.org/sindresorhus/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.
+> Terminal string styling done right
 
-[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.
+[![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) 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](screenshot.png)
+![screenshot](https://github.com/sindresorhus/ansi-styles/raw/master/screenshot.png)
 
 
 ## Why
 
-- **Doesn't extend String.prototype**
+- Highly performant
+- Doesn't extend `String.prototype`
 - Expressive API
+- Ability to nest styles
 - Clean and focused
 - Auto-detects color support
 - Actively maintained
+- [Used by ~3000 modules](https://www.npmjs.com/browse/depended/chalk)
 
 
 ## Install
 
-Install with [npm](https://npmjs.org/package/chalk): `npm install --save chalk`
+```
+$ npm install --save chalk
+```
 
 
-## Example
+## Usage
 
-Chalk comes with an easy to use composable API where you just chain the styles you want.
+Chalk comes with an easy to use composable API where you just chain and nest the styles you want.
 
 ```js
 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
+chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz');
 
 // nest styles
 chalk.red('Hello', chalk.underline.bgBlue('world') + '!');
 
-// pass in multiple arguments
-console.log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')) 
+// nest styles of the same type even (color, underline, background)
+chalk.green(
+	'I am a green line ' +
+	chalk.blue.underline.bold('with a blue substring') +
+	' that becomes green again!'
+);
 ```
 
-You can easily define your own themes.
+Easily define your own themes.
 
 ```js
 var chalk = require('chalk');
@@ -54,81 +73,125 @@ var error = chalk.bold.red;
 console.log(error('Error!'));
 ```
 
+Take advantage of console.log [string substitution](http://nodejs.org/docs/latest/api/console.html#console_console_log_data).
+
+```js
+var name = 'Sindre';
+console.log(chalk.green('Hello %s'), name);
+//=> Hello Sindre
+```
+
 
 ## API
 
-### chalk.\<style>\[.\<style>...](string)
+### chalk.`<style>[.<style>...](string, [string...])`
 
-Chain [styles](#styles) and call the last one as a method with a string argument.
+Example: `chalk.red.bold.underline('Hello', 'world');`
 
-Multiple arguments are also supported. Chalk will add a space between each one.
+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:
 
-Detect whether the terminal [supports color](https://github.com/sindresorhus/has-color).
+```js
+var ctx = new chalk.constructor({enabled: false});
+```
+
+### 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 your own.
+
 ```js
 var chalk = require('chalk');
 
 console.log(chalk.styles.red);
-//=> ['\x1b[31m', '\x1b[39m']
+//=> {open: '\u001b[31m', close: '\u001b[39m'}
 
-console.log(chalk.styles.red[0] + 'Hello' + chalk.styles.red[1]);
-// first item is the style escape code and second is the reset escape code
+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).
+
 ### chalk.stripColor(string)
 
-Strip color from a string.
+[Strip color](https://github.com/sindresorhus/strip-ansi) from a string.
 
+Can be useful in combination with `.supportsColor` to strip color on externally styled text when it's not supported.
 
-## Styles
+Example:
 
-### General
+```js
+var chalk = require('chalk');
+var styledString = getText();
 
-- reset
-- bold
-- italic
-- underline
-- inverse
-- strikethrough
+if (!chalk.supportsColor) {
+	styledString = chalk.stripColor(styledString);
+}
+```
 
-### Text colors
 
-- black
-- red
-- green
-- yellow
-- blue
-- magenta
-- cyan
-- white
-- gray
+## Styles
+
+### Modifiers
+
+- `reset`
+- `bold`
+- `dim`
+- `italic` *(not widely supported)*
+- `underline`
+- `inverse`
+- `hidden`
+- `strikethrough` *(not widely supported)*
+
+### Colors
+
+- `black`
+- `red`
+- `green`
+- `yellow`
+- `blue` *(on Windows the bright version is used as normal blue is illegible)*
+- `magenta`
+- `cyan`
+- `white`
+- `gray`
 
 ### Background colors
 
-- bgBlack
-- bgRed
-- bgGreen
-- bgYellow
-- bgBlue
-- bgMagenta
-- bgCyan
-- bgWhite
+- `bgBlack`
+- `bgRed`
+- `bgGreen`
+- `bgYellow`
+- `bgBlue`
+- `bgMagenta`
+- `bgCyan`
+- `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 License • © [Sindre Sorhus](http://sindresorhus.com)
+MIT © [Sindre Sorhus](http://sindresorhus.com)

package/chalk.js

@@ -1,64 +0,0 @@
-'use strict';
-var ansi = require('ansi-styles');
-var defineProps = Object.defineProperties;
-
-ansi.grey = ansi.gray;
-
-var styles = (function () {
-	var ret = {};
-
-	Object.keys(ansi).forEach(function (key) {
-		ret[key] = {
-			get: function () {
-				this._styles.push(key);
-				return this;
-			}
-		};
-	});
-
-	return ret;
-})();
-
-var chalk = module.exports = defineProps({}, init());
-
-function init() {
-	var ret = {};
-
-	Object.keys(styles).forEach(function (name) {
-		ret[name] = {
-			get: function () {
-				var obj = defineProps(function self() {
-					var str = [].slice.call(arguments).join(' ');
-
-					if (!chalk.enabled) {
-						return str;
-					}
-
-					return self._styles.reduce(function (str, name) {
-						var code = ansi[name];
-						return code[0] + (str || '') + code[1];
-					}, str);
-				}, styles);
-
-				obj._styles = [];
-
-				return obj[name];
-			}
-		}
-	});
-
-	return ret;
-}
-
-chalk.styles = ansi;
-
-chalk.stripColor = function (str) {
-	return typeof str === 'string' ? str.replace(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/g, '') : str;
-};
-
-chalk.supportsColor = require('has-color');
-
-// detect mode if not set manually
-if (chalk.enabled === undefined) {
-	chalk.enabled = chalk.supportsColor;
-}