ANSI escape codes for styling strings in the terminal. 

ANSI escape codes for styling strings in the terminal

sindresorhus

ansi-styles

		The ANSI terminal control sequence for starting this style.

		The ANSI terminal control sequence for ending this style.

		ansi16m(red: number, green: number, blue: number): string;

		The ANSI terminal control sequence for ending this color.

		Make text italic. (Not widely supported)

		Make text underline. (Not widely supported)

		Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.

		Inverse background and foreground colors.

		Prints the text, but makes it invisible.

		Puts a horizontal line through the center of the text. (Not widely supported)

		Convert from the RGB color space to the ANSI 256 color space.

		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.

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`;

			// 21 isn't widely supported and 22 does the same thing

	// Alias bright black as gray (and grey)

	styles.color.gray = styles.color.blackBright;

	styles.bgColor.bgGray = styles.bgColor.bgBlackBright;

	styles.color.grey = styles.color.blackBright;

	styles.bgColor.bgGrey = styles.bgColor.bgBlackBright;

	for (const [groupName, group] of Object.entries(styles)) {

		for (const [styleName, style] of Object.entries(group)) {

		Object.defineProperty(styles, groupName, {

	Object.defineProperty(styles, 'codes', {

	styles.bgColor.ansi256 = wrapAnsi256(ANSI_BACKGROUND_OFFSET);

	styles.bgColor.ansi16m = wrapAnsi16m(ANSI_BACKGROUND_OFFSET);

	// From https://github.com/Qix-/color-convert/blob/3f0e0d4e92e235796ccb17f6e85c72094a651f49/conversions.js

	styles.rgbToAnsi256 = (red, green, blue) => {

		// We use the extended greyscale palette here, with the exception of

		// black and white. normal palette only has 4 greyscale shades.

			return Math.round(((red - 8) / 247) * 24) + 232;

	"description": "ANSI escape codes for styling strings in the terminal",

	"funding": "https://github.com/chalk/ansi-styles?sponsor=1",

		"screenshot": "svg-term --command='node screenshot' --out=screenshot.svg --padding=3 --width=55 --height=3 --at=1000 --no-cursor"

> [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles) for styling strings in the terminal

You probably want the higher-level [chalk](https://github.com/chalk/chalk) module for styling your strings.

console.log(`${style.green.open}Hello world!${style.green.close}`);

// Color conversion between 16/256/truecolor

// NOTE: If conversion goes to 16 colors or 256 colors, the original color

//       may be degraded to fit that color palette. This means terminals

//       that do not support 16 million colors will best-match the

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}`)

Each style has an `open` and `close` property.

- `overline` *Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.*

- `strikethrough` *(Not widely supported)*

- `bgBlackBright` (alias: `bgGray`, `bgGrey`)

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.

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.

## [256 / 16 million (TrueColor) support](https://gist.github.com/XVilka/8346728)

`ansi-styles` allows converting between various color formats and ANSI escapes, with support for 256 and 16 million colors.

The following color spaces from `color-convert` are supported:

To use these, call the associated conversion function with the intended output, for example:

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

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

- [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) - ANSI escape codes for manipulating the terminal

- [Sindre Sorhus](https://github.com/sindresorhus)

Available as part of the Tidelift Subscription.

The maintainers of `ansi-styles` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-ansi-styles?utm_source=npm-ansi-styles&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)

		@@ -15,6 +15,2 @@ declare namespace ansiStyles {
		interface ColorBase {
		ansi256(code: number): string;

		ansi16m(red: number, green: number, blue: number): string;

		/**
		@@ -24,2 +20,6 @@ The ANSI terminal control sequence for ending this color.
		readonly close: string;

		ansi256(code: number): string;

		ansi16m(red: number, green: number, blue: number): string;
		}
		@@ -54,2 +54,9 @@
		/**
		Make text overline.

		Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.
		*/
		readonly overline: CSPair;

		/**
		Inverse background and foreground colors.
		@@ -56,0 +63,0 @@ */

		@@ -19,2 +19,3 @@ 'use strict';
		underline: [4, 24],
		overline: [53, 55],
		inverse: [7, 27],
		@@ -21,0 +22,0 @@ hidden: [8, 28],

		{
		"name": "ansi-styles",
		"version": "5.0.0",
		"version": "5.1.0",
		"description": "ANSI escape codes for styling strings in the terminal",
		@@ -47,8 +47,7 @@ "license": "MIT",
		"devDependencies": {
		"@types/color-convert": "^1.9.0",
		"ava": "^2.3.0",
		"ava": "^2.4.0",
		"svg-term-cli": "^2.1.1",
		"tsd": "^0.11.0",
		"xo": "^0.25.3"
		"tsd": "^0.14.0",
		"xo": "^0.37.1"
		}
		}

		@@ -45,2 +45,3 @@ # ansi-styles
		- `underline`
		- `overline` Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.
		- `inverse`
		@@ -47,0 +48,0 @@ - `hidden`

Improved metrics