chalk 0.2.0 → 0.5.0

package/index.js

@@ -0,0 +1,76 @@
+'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;
+var chalk = module.exports;
+
+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 ret;
+})();
+
+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(' ');
+
+	if (!chalk.enabled || !str) {
+		return str;
+	}
+
+	var nestedStyles = applyStyle._styles;
+
+	for (var i = 0; i < nestedStyles.length; 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) {
+		var style = defineProps(applyStyle, styles);
+		ret[name] = {
+			get: function () {
+				style._styles = [];
+				return style[name];
+			}
+		};
+	});
+
+	return ret;
+}
+
+defineProps(chalk, 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;
+}

package/package.json

@@ -1,7 +1,23 @@
 {
   "name": "chalk",
-  "version": "0.2.0",
-  "description": "Terminal string styling done right",
+  "version": "0.5.0",
+  "description": "Terminal string styling done right. Created because the `colors` module does some really horrible things.",
+  "license": "MIT",
+  "repository": "sindresorhus/chalk",
+  "maintainers": [
+    "Sindre Sorhus <sindresorhus@gmail.com> (http://sindresorhus.com)",
+    "Joshua Appelman <joshua@jbna.nl>"
+  ],
+  "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": "^1.1.0",
+    "escape-string-regexp": "^1.0.0",
+    "has-ansi": "^0.1.0",
+    "strip-ansi": "^0.3.0",
+    "supports-color": "^0.2.0"
   },
   "devDependencies": {
-    "mocha": "~1.12.0"
-  },
-  "engines": {
-    "node": ">=0.8.0"
+    "matcha": "^0.5.0",
+    "mocha": "*"
   }
 }

package/readme.md

@@ -1,49 +1,63 @@
-# chalk [![Build Status](https://secure.travis-ci.org/sindresorhus/chalk.png?branch=master)](http://travis-ci.org/sindresorhus/chalk)
+# <img width="300" src="https://cdn.rawgit.com/sindresorhus/chalk/77ae94f63ab1ac61389b190e5a59866569d1a376/logo.svg" alt="chalk">
 
-> 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)
+
+[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.
 
 **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 1000+ modules](https://npmjs.org/browse/depended/chalk)
 
 
 ## Install
 
-Install with [npm](https://npmjs.org/package/chalk): `npm install --save chalk`
+```sh
+$ 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!'));
+console.log(  chalk.blue('Hello world!')  );
 
 // combine styled and normal strings
-console.log(chalk.blue('Hello') + 'World' + chalk.red('!'));
+console.log(  chalk.blue('Hello'), 'World' + chalk.red('!')  );
 
 // compose multiple styles using the chainable API
-console.log(chalk.blue.bgRed.bold('Hello world!'));
+console.log(  chalk.blue.bgRed.bold('Hello world!')  );
+
+// pass in multiple arguments
+console.log(  chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')  );
 
 // nest styles
-chalk.red('Hello' + chalk.underline.bgBlue('world') + '!');
+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!')  );
 ```
 
-You can easily define your own themes.
+Easily define your own themes.
 
 ```js
 var chalk = require('chalk');
@@ -51,13 +65,24 @@ 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');`
 
+Chain [styles](#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
 
@@ -65,7 +90,7 @@ Color support is automatically detected, but you can override it.
 
 ### chalk.supportsColor
 
-Detect whether the terminal [supports color](https://github.com/sindresorhus/has-color).
+Detect whether the terminal [supports color](https://github.com/sindresorhus/supports-color).
 
 Can be overridden by the user with the flags `--color` and `--no-color`.
 
@@ -75,56 +100,76 @@ Used internally and handled for you, but exposed for convenience.
 
 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.
+
 ```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.
+
+Example:
+
+```js
+var chalk = require('chalk');
+var styledString = getText();
+
+if (!chalk.supportsColor) {
+	styledString = chalk.stripColor(styledString);
+}
+```
 
 
 ## Styles
 
 ### General
 
-- reset
-- bold
-- italic
-- underline
-- inverse
-- strikethrough
+- `reset`
+- `bold`
+- `dim`
+- `italic` *(not widely supported)*
+- `underline`
+- `inverse`
+- `hidden`
+- `strikethrough` *(not widely supported)*
 
 ### Text colors
 
-- black
-- red
-- green
-- yellow
-- blue
-- magenta
-- cyan
-- white
-- gray
+- `black`
+- `red`
+- `green`
+- `yellow`
+- `blue`
+- `magenta`
+- `cyan`
+- `white`
+- `gray`
 
 ### Background colors
 
-- bgBlack
-- bgRed
-- bgGreen
-- bgYellow
-- bgBlue
-- bgMagenta
-- bgCyan
-- bgWhite
+- `bgBlack`
+- `bgRed`
+- `bgGreen`
+- `bgYellow`
+- `bgBlue`
+- `bgMagenta`
+- `bgCyan`
+- `bgWhite`
 
 
 ## License
 
-MIT License • © [Sindre Sorhus](http://sindresorhus.com)
+MIT © [Sindre Sorhus](http://sindresorhus.com)

package/chalk.js

@@ -1,60 +0,0 @@
-'use strict';
-var ansi = require('ansi-styles');
-var defineProps = Object.defineProperties;
-
-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(str) {
-					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 str.replace(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/g, '');
-};
-
-chalk.supportsColor = require('has-color');
-
-// detect mode if not set manually
-if (chalk.enabled === undefined) {
-	chalk.enabled = chalk.supportsColor;
-}