chalk 0.3.0 → 0.4.0

package/{chalk.js → index.js}

@@ -1,12 +1,15 @@
 'use strict';
 var ansi = require('ansi-styles');
+var stripAnsi = require('strip-ansi');
+var hasColor = require('has-color');
 var defineProps = Object.defineProperties;
-
-ansi.grey = ansi.gray;
+var chalk = module.exports;
 
 var styles = (function () {
 	var ret = {};
 
+	ansi.grey = ansi.gray;
+
 	Object.keys(ansi).forEach(function (key) {
 		ret[key] = {
 			get: function () {
@@ -19,8 +22,6 @@ var styles = (function () {
 	return ret;
 })();
 
-var chalk = module.exports = defineProps({}, init());
-
 function init() {
 	var ret = {};
 
@@ -36,7 +37,7 @@ function init() {
 
 					return self._styles.reduce(function (str, name) {
 						var code = ansi[name];
-						return code[0] + (str || '') + code[1];
+						return str ? code.open + str + code.close : '';
 					}, str);
 				}, styles);
 
@@ -50,13 +51,11 @@ function init() {
 	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;
-};
+defineProps(chalk, init());
 
-chalk.supportsColor = require('has-color');
+chalk.styles = ansi;
+chalk.stripColor = stripAnsi;
+chalk.supportsColor = hasColor;
 
 // detect mode if not set manually
 if (chalk.enabled === undefined) {

package/package.json

@@ -1,7 +1,23 @@
 {
   "name": "chalk",
-  "version": "0.3.0",
-  "description": "Terminal string styling done right",
+  "version": "0.4.0",
+  "description": "Terminal string styling done right. Created because the `colors` module does some really horrible things.",
+  "license": "MIT",
+  "repository": "sindresorhus/chalk",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "http://sindresorhus.com"
+  },
+  "engines": {
+    "node": ">=0.8.0"
+  },
+  "scripts": {
+    "test": "mocha"
+  },
+  "files": [
+    "index.js"
+  ],
   "keywords": [
     "color",
     "colour",
@@ -23,33 +39,12 @@
     "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.0.0",
+    "strip-ansi": "~0.1.0"
   },
   "devDependencies": {
-    "mocha": "~1.12.0"
-  },
-  "engines": {
-    "node": ">=0.8.0"
+    "mocha": "~1.x"
   }
 }

package/readme.md

@@ -1,8 +1,10 @@
-# chalk [![Build Status](https://secure.travis-ci.org/sindresorhus/chalk.png?branch=master)](http://travis-ci.org/sindresorhus/chalk)
+# <img width="250" src="logo.png" 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://secure.travis-ci.org/sindresorhus/chalk.png?branch=master)](http://travis-ci.org/sindresorhus/chalk)
+
+[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.**
 
@@ -16,6 +18,7 @@
 - Clean and focused
 - Auto-detects color support
 - Actively maintained
+- [Used by 150+ modules](https://npmjs.org/browse/depended/chalk)
 
 
 ## Install
@@ -25,25 +28,25 @@ Install with [npm](https://npmjs.org/package/chalk): `npm install --save chalk`
 
 ## Example
 
-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!')  );
 
 // nest styles
-chalk.red('Hello', chalk.underline.bgBlue('world') + '!');
+console.log(  chalk.red('Hello', chalk.underline.bgBlue('world') + '!')  );
 
 // pass in multiple arguments
-console.log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')) 
+console.log(  chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')  );
 ```
 
 You can easily define your own themes.
@@ -57,11 +60,13 @@ console.log(error('Error!'));
 
 ## API
 
-### chalk.\<style>\[.\<style>...](string)
+### chalk.`<style>[.<style>...](string, [string...])`
+
+Example: `chalk.red.bold.underline('Hello', 'world');`
 
-Chain [styles](#styles) and call the last one as a method with a string argument.
+Chain [styles](#styles) and call the last one as a method with a string argument. Order doesn't matter.
 
-Multiple arguments are also supported. Chalk will add a space between each one.
+Multiple arguments will be separated by space.
 
 ### chalk.enabled
 
@@ -79,19 +84,33 @@ 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: '\x1b[31m', close: '\x1b[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.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 = fromExternal();
+
+if (!chalk.supportsColor) {
+	chalk.stripColor(styledString);
+}
+```
 
 
 ## Styles
@@ -131,4 +150,9 @@ Strip color from a string.
 
 ## License
 
-MIT License • © [Sindre Sorhus](http://sindresorhus.com)
+MIT © [Sindre Sorhus](http://sindresorhus.com)
+
+
+-
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/sindresorhus/chalk/trend.png)](https://bitdeli.com/free "Bitdeli Badge")