ansi-styles 5.2.0 → 6.1.1

package/index.d.ts

@@ -1,167 +1,190 @@
-declare namespace ansiStyles {
-	interface CSPair {
-		/**
-		The ANSI terminal control sequence for starting this style.
-		*/
-		readonly open: string;
-
-		/**
-		The ANSI terminal control sequence for ending this style.
-		*/
-		readonly close: string;
-	}
-
-	interface ColorBase {
-		/**
-		The ANSI terminal control sequence for ending this color.
-		*/
-		readonly close: string;
-
-		ansi256(code: number): string;
-
-		ansi16m(red: number, green: number, blue: number): string;
-	}
-
-	interface Modifier {
-		/**
-		Resets the current color chain.
-		*/
-		readonly reset: CSPair;
-
-		/**
-		Make text bold.
-		*/
-		readonly bold: CSPair;
-
-		/**
-		Emitting only a small amount of light.
-		*/
-		readonly dim: CSPair;
-
-		/**
-		Make text italic. (Not widely supported)
-		*/
-		readonly italic: CSPair;
-
-		/**
-		Make text underline. (Not widely supported)
-		*/
-		readonly underline: CSPair;
-
-		/**
-		Make text overline.
-
-		Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.
-		*/
-		readonly overline: CSPair;
-
-		/**
-		Inverse background and foreground colors.
-		*/
-		readonly inverse: CSPair;
-
-		/**
-		Prints the text, but makes it invisible.
-		*/
-		readonly hidden: CSPair;
-
-		/**
-		Puts a horizontal line through the center of the text. (Not widely supported)
-		*/
-		readonly strikethrough: CSPair;
-	}
-
-	interface ForegroundColor {
-		readonly black: CSPair;
-		readonly red: CSPair;
-		readonly green: CSPair;
-		readonly yellow: CSPair;
-		readonly blue: CSPair;
-		readonly cyan: CSPair;
-		readonly magenta: CSPair;
-		readonly white: CSPair;
-
-		/**
-		Alias for `blackBright`.
-		*/
-		readonly gray: CSPair;
-
-		/**
-		Alias for `blackBright`.
-		*/
-		readonly grey: CSPair;
-
-		readonly blackBright: CSPair;
-		readonly redBright: CSPair;
-		readonly greenBright: CSPair;
-		readonly yellowBright: CSPair;
-		readonly blueBright: CSPair;
-		readonly cyanBright: CSPair;
-		readonly magentaBright: CSPair;
-		readonly whiteBright: CSPair;
-	}
-
-	interface BackgroundColor {
-		readonly bgBlack: CSPair;
-		readonly bgRed: CSPair;
-		readonly bgGreen: CSPair;
-		readonly bgYellow: CSPair;
-		readonly bgBlue: CSPair;
-		readonly bgCyan: CSPair;
-		readonly bgMagenta: CSPair;
-		readonly bgWhite: CSPair;
-
-		/**
-		Alias for `bgBlackBright`.
-		*/
-		readonly bgGray: CSPair;
-
-		/**
-		Alias for `bgBlackBright`.
-		*/
-		readonly bgGrey: CSPair;
-
-		readonly bgBlackBright: CSPair;
-		readonly bgRedBright: CSPair;
-		readonly bgGreenBright: CSPair;
-		readonly bgYellowBright: CSPair;
-		readonly bgBlueBright: CSPair;
-		readonly bgCyanBright: CSPair;
-		readonly bgMagentaBright: CSPair;
-		readonly bgWhiteBright: CSPair;
-	}
-
-	interface ConvertColor {
-		/**
-		Convert from the RGB color space to the ANSI 256 color space.
-
-		@param red - (`0...255`)
-		@param green - (`0...255`)
-		@param blue - (`0...255`)
-		*/
-		rgbToAnsi256(red: number, green: number, blue: number): number;
-
-		/**
-		Convert from the RGB HEX color space to the RGB color space.
-
-		@param hex - A hexadecimal string containing RGB data.
-		*/
-		hexToRgb(hex: string): [red: number, green: number, blue: number];
-
-		/**
-		Convert from the RGB HEX color space to the ANSI 256 color space.
-
-		@param hex - A hexadecimal string containing RGB data.
-		*/
-		hexToAnsi256(hex: string): number;
-	}
+export interface CSPair { // eslint-disable-line @typescript-eslint/naming-convention
+	/**
+	The ANSI terminal control sequence for starting this style.
+	*/
+	readonly open: string;
+
+	/**
+	The ANSI terminal control sequence for ending this style.
+	*/
+	readonly close: string;
+}
+
+export interface ColorBase {
+	/**
+	The ANSI terminal control sequence for ending this color.
+	*/
+	readonly close: string;
+
+	ansi(code: number): string;
+
+	ansi256(code: number): string;
+
+	ansi16m(red: number, green: number, blue: number): string;
+}
+
+export interface Modifier {
+	/**
+	Resets the current color chain.
+	*/
+	readonly reset: CSPair;
+
+	/**
+	Make text bold.
+	*/
+	readonly bold: CSPair;
+
+	/**
+	Emitting only a small amount of light.
+	*/
+	readonly dim: CSPair;
+
+	/**
+	Make text italic. (Not widely supported)
+	*/
+	readonly italic: CSPair;
+
+	/**
+	Make text underline. (Not widely supported)
+	*/
+	readonly underline: CSPair;
+
+	/**
+	Make text overline.
+
+	Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.
+	*/
+	readonly overline: CSPair;
+
+	/**
+	Inverse background and foreground colors.
+	*/
+	readonly inverse: CSPair;
+
+	/**
+	Prints the text, but makes it invisible.
+	*/
+	readonly hidden: CSPair;
+
+	/**
+	Puts a horizontal line through the center of the text. (Not widely supported)
+	*/
+	readonly strikethrough: CSPair;
+}
+
+export interface ForegroundColor {
+	readonly black: CSPair;
+	readonly red: CSPair;
+	readonly green: CSPair;
+	readonly yellow: CSPair;
+	readonly blue: CSPair;
+	readonly cyan: CSPair;
+	readonly magenta: CSPair;
+	readonly white: CSPair;
+
+	/**
+	Alias for `blackBright`.
+	*/
+	readonly gray: CSPair;
+
+	/**
+	Alias for `blackBright`.
+	*/
+	readonly grey: CSPair;
+
+	readonly blackBright: CSPair;
+	readonly redBright: CSPair;
+	readonly greenBright: CSPair;
+	readonly yellowBright: CSPair;
+	readonly blueBright: CSPair;
+	readonly cyanBright: CSPair;
+	readonly magentaBright: CSPair;
+	readonly whiteBright: CSPair;
+}
+
+export interface BackgroundColor {
+	readonly bgBlack: CSPair;
+	readonly bgRed: CSPair;
+	readonly bgGreen: CSPair;
+	readonly bgYellow: CSPair;
+	readonly bgBlue: CSPair;
+	readonly bgCyan: CSPair;
+	readonly bgMagenta: CSPair;
+	readonly bgWhite: CSPair;
+
+	/**
+	Alias for `bgBlackBright`.
+	*/
+	readonly bgGray: CSPair;
+
+	/**
+	Alias for `bgBlackBright`.
+	*/
+	readonly bgGrey: CSPair;
+
+	readonly bgBlackBright: CSPair;
+	readonly bgRedBright: CSPair;
+	readonly bgGreenBright: CSPair;
+	readonly bgYellowBright: CSPair;
+	readonly bgBlueBright: CSPair;
+	readonly bgCyanBright: CSPair;
+	readonly bgMagentaBright: CSPair;
+	readonly bgWhiteBright: CSPair;
+}
+
+export interface ConvertColor {
+	/**
+	Convert from the RGB color space to the ANSI 256 color space.
+
+	@param red - (`0...255`)
+	@param green - (`0...255`)
+	@param blue - (`0...255`)
+	*/
+	rgbToAnsi256(red: number, green: number, blue: number): number;
+
+	/**
+	Convert from the RGB HEX color space to the RGB color space.
+
+	@param hex - A hexadecimal string containing RGB data.
+	*/
+	hexToRgb(hex: string): [red: number, green: number, blue: number];
+
+	/**
+	Convert from the RGB HEX color space to the ANSI 256 color space.
+
+	@param hex - A hexadecimal string containing RGB data.
+	*/
+	hexToAnsi256(hex: string): number;
+
+	/**
+	Convert from the ANSI 256 color space to the ANSI 16 color space.
+
+	@param code - A number representing the ANSI 256 color.
+	*/
+	ansi256ToAnsi(code: number): number;
+
+	/**
+	Convert from the RGB color space to the ANSI 16 color space.
+
+	@param red - (`0...255`)
+	@param green - (`0...255`)
+	@param blue - (`0...255`)
+	*/
+	rgbToAnsi(red: number, green: number, blue: number): number;
+
+	/**
+	Convert from the RGB HEX color space to the ANSI 16 color space.
+
+	@param hex - A hexadecimal string containing RGB data.
+	*/
+	hexToAnsi(hex: string): number;
 }
 
 declare const ansiStyles: {
-	readonly modifier: ansiStyles.Modifier;
-	readonly color: ansiStyles.ForegroundColor & ansiStyles.ColorBase;
-	readonly bgColor: ansiStyles.BackgroundColor & ansiStyles.ColorBase;
+	readonly modifier: Modifier;
+	readonly color: ColorBase & ForegroundColor;
+	readonly bgColor: ColorBase & BackgroundColor;
 	readonly codes: ReadonlyMap<number, number>;
-} & ansiStyles.BackgroundColor & ansiStyles.ForegroundColor & ansiStyles.Modifier & ansiStyles.ConvertColor;
+} & ForegroundColor & BackgroundColor & Modifier & ConvertColor;
 
-export = ansiStyles;
+export default ansiStyles;

package/index.js

@@ -1,7 +1,7 @@
-'use strict';
-
 const ANSI_BACKGROUND_OFFSET = 10;
 
+const wrapAnsi16 = (offset = 0) => code => `\u001B[${code + offset}m`;
+
 const wrapAnsi256 = (offset = 0) => code => `\u001B[${38 + offset};5;${code}m`;
 
 const wrapAnsi16m = (offset = 0) => (red, green, blue) => `\u001B[${38 + offset};2;${red};${green};${blue}m`;
@@ -19,7 +19,7 @@ function assembleStyles() {
 			overline: [53, 55],
 			inverse: [7, 27],
 			hidden: [8, 28],
-			strikethrough: [9, 29]
+			strikethrough: [9, 29],
 		},
 		color: {
 			black: [30, 39],
@@ -39,7 +39,7 @@ function assembleStyles() {
 			blueBright: [94, 39],
 			magentaBright: [95, 39],
 			cyanBright: [96, 39],
-			whiteBright: [97, 39]
+			whiteBright: [97, 39],
 		},
 		bgColor: {
 			bgBlack: [40, 49],
@@ -59,8 +59,8 @@ function assembleStyles() {
 			bgBlueBright: [104, 49],
 			bgMagentaBright: [105, 49],
 			bgCyanBright: [106, 49],
-			bgWhiteBright: [107, 49]
-		}
+			bgWhiteBright: [107, 49],
+		},
 	};
 
 	// Alias bright black as gray (and grey)
@@ -73,7 +73,7 @@ function assembleStyles() {
 		for (const [styleName, style] of Object.entries(group)) {
 			styles[styleName] = {
 				open: `\u001B[${style[0]}m`,
-				close: `\u001B[${style[1]}m`
+				close: `\u001B[${style[1]}m`,
 			};
 
 			group[styleName] = styles[styleName];
@@ -83,20 +83,22 @@ function assembleStyles() {
 
 		Object.defineProperty(styles, groupName, {
 			value: group,
-			enumerable: false
+			enumerable: false,
 		});
 	}
 
 	Object.defineProperty(styles, 'codes', {
 		value: codes,
-		enumerable: false
+		enumerable: false,
 	});
 
 	styles.color.close = '\u001B[39m';
 	styles.bgColor.close = '\u001B[49m';
 
+	styles.color.ansi = wrapAnsi16();
 	styles.color.ansi256 = wrapAnsi256();
 	styles.color.ansi16m = wrapAnsi16m();
+	styles.bgColor.ansi = wrapAnsi16(ANSI_BACKGROUND_OFFSET);
 	styles.bgColor.ansi256 = wrapAnsi256(ANSI_BACKGROUND_OFFSET);
 	styles.bgColor.ansi16m = wrapAnsi16m(ANSI_BACKGROUND_OFFSET);
 
@@ -118,47 +120,100 @@ function assembleStyles() {
 					return Math.round(((red - 8) / 247) * 24) + 232;
 				}
 
-				return 16 +
-					(36 * Math.round(red / 255 * 5)) +
-					(6 * Math.round(green / 255 * 5)) +
-					Math.round(blue / 255 * 5);
+				return 16
+					+ (36 * Math.round(red / 255 * 5))
+					+ (6 * Math.round(green / 255 * 5))
+					+ Math.round(blue / 255 * 5);
 			},
-			enumerable: false
+			enumerable: false,
 		},
 		hexToRgb: {
 			value: hex => {
-				const matches = /(?<colorString>[a-f\d]{6}|[a-f\d]{3})/i.exec(hex.toString(16));
+				const matches = /[a-f\d]{6}|[a-f\d]{3}/i.exec(hex.toString(16));
 				if (!matches) {
 					return [0, 0, 0];
 				}
 
-				let {colorString} = matches.groups;
+				let [colorString] = matches;
 
 				if (colorString.length === 3) {
-					colorString = colorString.split('').map(character => character + character).join('');
+					colorString = [...colorString].map(character => character + character).join('');
 				}
 
 				const integer = Number.parseInt(colorString, 16);
 
 				return [
+					/* eslint-disable no-bitwise */
 					(integer >> 16) & 0xFF,
 					(integer >> 8) & 0xFF,
-					integer & 0xFF
+					integer & 0xFF,
+					/* eslint-enable no-bitwise */
 				];
 			},
-			enumerable: false
+			enumerable: false,
 		},
 		hexToAnsi256: {
 			value: hex => styles.rgbToAnsi256(...styles.hexToRgb(hex)),
-			enumerable: false
-		}
+			enumerable: false,
+		},
+		ansi256ToAnsi: {
+			value: code => {
+				if (code < 8) {
+					return 30 + code;
+				}
+
+				if (code < 16) {
+					return 90 + (code - 8);
+				}
+
+				let red;
+				let green;
+				let blue;
+
+				if (code >= 232) {
+					red = (((code - 232) * 10) + 8) / 255;
+					green = red;
+					blue = red;
+				} else {
+					code -= 16;
+
+					const remainder = code % 36;
+
+					red = Math.floor(code / 36) / 5;
+					green = Math.floor(remainder / 6) / 5;
+					blue = (remainder % 6) / 5;
+				}
+
+				const value = Math.max(red, green, blue) * 2;
+
+				if (value === 0) {
+					return 30;
+				}
+
+				// eslint-disable-next-line no-bitwise
+				let result = 30 + ((Math.round(blue) << 2) | (Math.round(green) << 1) | Math.round(red));
+
+				if (value === 2) {
+					result += 60;
+				}
+
+				return result;
+			},
+			enumerable: false,
+		},
+		rgbToAnsi: {
+			value: (red, green, blue) => styles.ansi256ToAnsi(styles.rgbToAnsi256(red, green, blue)),
+			enumerable: false,
+		},
+		hexToAnsi: {
+			value: hex => styles.ansi256ToAnsi(styles.hexToAnsi256(hex)),
+			enumerable: false,
+		},
 	});
 
 	return styles;
 }
 
-// Make the export immutable
-Object.defineProperty(module, 'exports', {
-	enumerable: true,
-	get: assembleStyles
-});
+const ansiStyles = assembleStyles();
+
+export default ansiStyles;

package/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://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:
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ansi-styles",
-	"version": "5.2.0",
+	"version": "6.1.1",
 	"description": "ANSI escape codes for styling strings in the terminal",
 	"license": "MIT",
 	"repository": "chalk/ansi-styles",
@@ -10,8 +10,10 @@
 		"email": "sindresorhus@gmail.com",
 		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=10"
+		"node": ">=12"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd",
@@ -44,9 +46,9 @@
 		"text"
 	],
 	"devDependencies": {
-		"ava": "^2.4.0",
+		"ava": "^3.15.0",
 		"svg-term-cli": "^2.1.1",
-		"tsd": "^0.14.0",
-		"xo": "^0.37.1"
+		"tsd": "^0.19.0",
+		"xo": "^0.47.0"
 	}
 }

package/readme.md

@@ -4,20 +4,20 @@
 
 You probably want the higher-level [chalk](https://github.com/chalk/chalk) module for styling your strings.
 
-<img src="screenshot.svg" width="900">
+![](screenshot.png)
 
 ## Install
 
-```
-$ npm install ansi-styles
+```sh
+npm install ansi-styles
 ```
 
 ## Usage
 
 ```js
-const style = require('ansi-styles');
+import styles from 'ansi-styles';
 
-console.log(`${style.green.open}Hello world!${style.green.close}`);
+console.log(`${styles.green.open}Hello world!${styles.green.close}`);
 
 
 // Color conversion between 256/truecolor
@@ -25,8 +25,9 @@ console.log(`${style.green.open}Hello world!${style.green.close}`);
 //       may be degraded to fit the new color palette. This means terminals
 //       that do not support 16 million colors will best-match the
 //       original color.
-console.log(`${style.color.ansi256(style.rgbToAnsi256(199, 20, 250))}Hello World${style.color.close}`)
-console.log(`${style.color.ansi16m(...style.hexToRgb('#abcdef'))}Hello World${style.color.close}`)
+console.log(`${styles.color.ansi(styles.rgbToAnsi(199, 20, 250))}Hello World${styles.color.close}`)
+console.log(`${styles.color.ansi256(styles.rgbToAnsi256(199, 20, 250))}Hello World${styles.color.close}`)
+console.log(`${styles.color.ansi16m(...styles.hexToRgb('#abcdef'))}Hello World${styles.color.close}`)
 ```
 
 ## API
@@ -89,43 +90,53 @@ Each style has an `open` and `close` property.
 
 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.
 
-- `style.modifier`
-- `style.color`
-- `style.bgColor`
+- `styles.modifier`
+- `styles.color`
+- `styles.bgColor`
 
 ###### Example
 
 ```js
-console.log(style.color.green.open);
+import styles from 'ansi-styles';
+
+console.log(styles.color.green.open);
 ```
 
-Raw escape codes (i.e. without the CSI escape prefix `\u001B[` and render mode postfix `m`) are available under `style.codes`, which returns a `Map` with the open codes as keys and close codes as values.
+Raw escape codes (i.e. without the CSI escape prefix `\u001B[` and render mode postfix `m`) are available under `styles.codes`, which returns a `Map` with the open codes as keys and close codes as values.
 
 ###### Example
 
 ```js
-console.log(style.codes.get(36));
+import styles from 'ansi-styles';
+
+console.log(styles.codes.get(36));
 //=> 39
 ```
 
-## [256 / 16 million (TrueColor) support](https://gist.github.com/XVilka/8346728)
+## 16 / 256 / 16 million (TrueColor) support
 
-`ansi-styles` allows converting between various color formats and ANSI escapes, with support for 256 and 16 million colors.
+`ansi-styles` allows converting between various color formats and ANSI escapes, with support for 16, 256 and [16 million colors](https://gist.github.com/XVilka/8346728).
 
-The following color spaces from `color-convert` are supported:
+The following color spaces are supported:
 
 - `rgb`
 - `hex`
 - `ansi256`
+- `ansi`
 
 To use these, call the associated conversion function with the intended output, for example:
 
 ```js
-style.color.ansi256(style.rgbToAnsi256(100, 200, 15)); // RGB to 256 color ansi foreground code
-style.bgColor.ansi256(style.hexToAnsi256('#C0FFEE')); // HEX to 256 color ansi foreground code
+import styles from 'ansi-styles';
+
+styles.color.ansi(styles.rgbToAnsi(100, 200, 15)); // RGB to 16 color ansi foreground code
+styles.bgColor.ansi(styles.hexToAnsi('#C0FFEE')); // HEX to 16 color ansi foreground code
+
+styles.color.ansi256(styles.rgbToAnsi256(100, 200, 15)); // RGB to 256 color ansi foreground code
+styles.bgColor.ansi256(styles.hexToAnsi256('#C0FFEE')); // HEX to 256 color ansi foreground code
 
-style.color.ansi16m(100, 200, 15); // RGB to 16 million color foreground code
-style.bgColor.ansi16m(...style.hexToRgb('#C0FFEE')); // Hex (RGB) to 16 million color foreground code
+styles.color.ansi16m(100, 200, 15); // RGB to 16 million color foreground code
+styles.bgColor.ansi16m(...styles.hexToRgb('#C0FFEE')); // Hex (RGB) to 16 million color foreground code
 ```
 
 ## Related