ansi-styles 1.1.0 → 2.0.0

package/index.js

@@ -1,40 +1,56 @@
 'use strict';
-var styles = module.exports;
 
-var codes = {
-	reset: [0, 0],
+var styles = module.exports = {
+	modifiers: {
+		reset: [0, 0],
+		bold: [1, 22], // 21 isn't widely supported and 22 does the same thing
+		dim: [2, 22],
+		italic: [3, 23],
+		underline: [4, 24],
+		inverse: [7, 27],
+		hidden: [8, 28],
+		strikethrough: [9, 29]
+	},
+	colors: {
+		black: [30, 39],
+		red: [31, 39],
+		green: [32, 39],
+		yellow: [33, 39],
+		blue: [34, 39],
+		magenta: [35, 39],
+		cyan: [36, 39],
+		white: [37, 39],
+		gray: [90, 39]
+	},
+	bgColors: {
+		bgBlack: [40, 49],
+		bgRed: [41, 49],
+		bgGreen: [42, 49],
+		bgYellow: [43, 49],
+		bgBlue: [44, 49],
+		bgMagenta: [45, 49],
+		bgCyan: [46, 49],
+		bgWhite: [47, 49]
+	}
+};
 
-	bold: [1, 22], // 21 isn't widely supported and 22 does the same thing
-	dim: [2, 22],
-	italic: [3, 23],
-	underline: [4, 24],
-	inverse: [7, 27],
-	hidden: [8, 28],
-	strikethrough: [9, 29],
+// fix humans
+styles.colors.grey = styles.colors.gray;
 
-	black: [30, 39],
-	red: [31, 39],
-	green: [32, 39],
-	yellow: [33, 39],
-	blue: [34, 39],
-	magenta: [35, 39],
-	cyan: [36, 39],
-	white: [37, 39],
-	gray: [90, 39],
+Object.keys(styles).forEach(function (groupName) {
+	var group = styles[groupName];
 
-	bgBlack: [40, 49],
-	bgRed: [41, 49],
-	bgGreen: [42, 49],
-	bgYellow: [43, 49],
-	bgBlue: [44, 49],
-	bgMagenta: [45, 49],
-	bgCyan: [46, 49],
-	bgWhite: [47, 49]
-};
+	Object.keys(group).forEach(function (styleName) {
+		var style = group[styleName];
+
+		styles[styleName] = group[styleName] = {
+			open: '\u001b[' + style[0] + 'm',
+			close: '\u001b[' + style[1] + 'm'
+		};
+	});
 
-Object.keys(codes).forEach(function (key) {
-	var val = codes[key];
-	var style = styles[key] = {};
-	style.open = '\u001b[' + val[0] + 'm';
-	style.close = '\u001b[' + val[1] + 'm';
+	Object.defineProperty(styles, groupName, {
+		value: group,
+		enumerable: false
+	});
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ansi-styles",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "ANSI escape codes for styling strings in the terminal",
   "license": "MIT",
   "repository": "sindresorhus/ansi-styles",

package/readme.md

@@ -4,7 +4,7 @@
 
 You probably want the higher-level [chalk](https://github.com/sindresorhus/chalk) module for styling your strings.
 
-![screenshot](screenshot.png)
+![](screenshot.png)
 
 
 ## Install
@@ -30,7 +30,7 @@ Each style has an `open` and `close` property.
 
 ## Styles
 
-### General
+### Modifiers
 
 - `reset`
 - `bold`
@@ -41,7 +41,7 @@ Each style has an `open` and `close` property.
 - `hidden`
 - `strikethrough` *(not widely supported)*
 
-### Text colors
+### Colors
 
 - `black`
 - `red`
@@ -65,6 +65,22 @@ Each style has an `open` and `close` property.
 - `bgWhite`
 
 
+## Advanced usage
+
+By default you get a map of styles, but the styles are also available as groups. They are non-enumerable so they don't show up unless you access them explicitly. This makes it easier to expose only a subset in a higher-level module.
+
+- `ansi.modifiers`
+- `ansi.colors`
+- `ansi.bgColors`
+
+
+###### Example
+
+```js
+console.log(ansi.colors.green.open);
+```
+
+
 ## License
 
 MIT © [Sindre Sorhus](http://sindresorhus.com)