ANSI escape codes for manipulating the terminal. 

ANSI escape codes for manipulating the terminal

sindresorhus

ansi-escapes

/* eslint-disable @typescript-eslint/member-ordering */

import type {LiteralUnion} from 'type-fest';

	The width is given as a number followed by a unit, or the word `'auto'`.

	- `N%`: N percent of the session's width or height.

	- `auto`: The image's inherent size will be used to determine an appropriate dimension.

	readonly width?: LiteralUnion<'auto', number | string>;

	The height is given as a number followed by a unit, or the word `'auto'`.

	readonly height?: LiteralUnion<'auto', number | string>;

	Annotations created this way can be shown using the "Show Annotations" iTerm command.

	Set the absolute position of the cursor. `x0` `y0` is the top left of the screen.

	cursorTo(x: number, y?: number): string;

	Set the position of the cursor relative to its current position.

	cursorMove(x: number, y?: number): string;

	Move cursor up a specific amount of rows.

	@param count - Count of rows to move up. Default is `1`.

	Move cursor down a specific amount of rows.

	@param count - Count of rows to move down. Default is `1`.

	Move cursor forward a specific amount of rows.

	@param count - Count of rows to move forward. Default is `1`.

	Move cursor backward a specific amount of rows.

	Enter the [alternative screen](https://terminalguide.namepad.de/mode/p47/).

	Exit the [alternative screen](https://terminalguide.namepad.de/mode/p47/), assuming `enterAlternativeScreen` was called before.

	[Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) Use [`supports-hyperlinks`](https://github.com/jamestalmage/supports-hyperlinks) to detect link support.

	link(text: string, url: string): string;

	_Currently only supported on iTerm2 >=3_

	See [term-img](https://github.com/sindresorhus/term-img) for a higher-level module.

	@param buffer - Buffer of an image. Usually read in with `fs.readFile()`.

	image(buffer: Buffer, options?: ImageOptions): string;

		[Inform iTerm2](https://www.iterm2.com/documentation-escape-codes.html) of the current directory to help semantic history and enable [Cmd-clicking relative paths](https://coderwall.com/p/b7e82q/quickly-open-files-in-iterm-with-cmd-click).

		@param cwd - Current directory. Default: `process.cwd()`.

		An annotation looks like this when shown:

		![screenshot of iTerm annotation](https://user-images.githubusercontent.com/924465/64382136-b60ac700-cfe9-11e9-8a35-9682e8dc4b72.png)

		See the [iTerm Proprietary Escape Codes documentation](https://iterm2.com/documentation-escape-codes.html) for more information.

		@param message - The message to display within the annotation. The `|` character is disallowed and will be stripped.

		@returns An escape code which will create an annotation when printed in iTerm2.

		annotation(message: string, options?: AnnotationOptions): string;

const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';

const isTerminalApp = !isBrowser && process.env.TERM_PROGRAM === 'Apple_Terminal';

const isWindows = !isBrowser && process.platform === 'win32';

	throw new Error('`process.cwd()` only works in Node.js, not the browser.');

		throw new TypeError('The `x` argument is required');

	return ESC + (y + 1) + SEP + (x + 1) + 'H';

ansiEscapes.cursorUp = (count = 1) => ESC + count + 'A';

ansiEscapes.cursorDown = (count = 1) => ESC + count + 'B';

ansiEscapes.cursorForward = (count = 1) => ESC + count + 'C';

ansiEscapes.cursorBackward = (count = 1) => ESC + count + 'D';

ansiEscapes.cursorSavePosition = isTerminalApp ? '\u001B7' : ESC + 's';

ansiEscapes.cursorRestorePosition = isTerminalApp ? '\u001B8' : ESC + 'u';

ansiEscapes.cursorGetPosition = ESC + '6n';

		clear += ansiEscapes.eraseLine + (i < count - 1 ? ansiEscapes.cursorUp() : '');

	// 1. Erases the screen (Only done in case `2` is not supported)

	// 2. Erases the whole screen including scrollback buffer

	// 3. Moves cursor to the top-left position

	// More info: https://www.real-world-systems.com/docs/ANSIcode.html

	: `${ansiEscapes.eraseScreen}${ESC}3J${ESC}H`;

ansiEscapes.enterAlternativeScreen = ESC + '?1049h';

ansiEscapes.exitAlternativeScreen = ESC + '?1049l';

ansiEscapes.image = (buffer, options = {}) => {

	let returnValue = `${OSC}1337;File=inline=1`;

		returnValue += `;width=${options.width}`;

		returnValue += `;height=${options.height}`;

	if (options.preserveAspectRatio === false) {

		returnValue += ';preserveAspectRatio=0';

	return returnValue + ':' + buffer.toString('base64') + BEL;

	setCwd: (cwd = cwdFunction()) => `${OSC}50;CurrentDir=${cwd}${BEL}`,

		const hasX = typeof options.x !== 'undefined';

		const hasY = typeof options.y !== 'undefined';

		if ((hasX || hasY) && !(hasX && hasY && typeof options.length !== 'undefined')) {

			throw new Error('`x`, `y` and `length` must be defined when `x` or `y` is defined');

		returnValue += options.isHidden ? 'AddHiddenAnnotation=' : 'AddAnnotation=';

					? [message, options.length, options.x, options.y]

	"description": "ANSI escape codes for manipulating the terminal",

	"repository": "sindresorhus/ansi-escapes",

	"funding": "https://github.com/sponsors/sindresorhus",

> [ANSI escape codes](http://www.termsys.demon.co.uk/vtansi.htm) for manipulating the terminal

// Moves the cursor two rows up and to the left

process.stdout.write(ansiEscapes.cursorUp(2) + ansiEscapes.cursorLeft);

**You can also use it in the browser with Xterm.js:**

terminal.write(ansiEscapes.cursorUp(2) + ansiEscapes.cursorLeft);

Set the absolute position of the cursor. `x0` `y0` is the top left of the screen.

Set the position of the cursor relative to its current position.

Move cursor up a specific amount of rows. Default is `1`.

Move cursor down a specific amount of rows. Default is `1`.

Move cursor forward a specific amount of columns. Default is `1`.

Move cursor backward a specific amount of columns. Default is `1`.

Erase from the current cursor position up the specified amount of rows.

Erase from the current cursor position to the end of the current line.

Enter the [alternative screen](https://terminalguide.namepad.de/mode/p47/).

Exit the [alternative screen](https://terminalguide.namepad.de/mode/p47/), assuming `enterAlternativeScreen` was called before.

[Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) Use [`supports-hyperlinks`](https://github.com/jamestalmage/supports-hyperlinks) to detect link support.

See [term-img](https://github.com/sindresorhus/term-img) for a higher-level module.

Buffer of an image. Usually read in with `fs.readFile()`.

The width and height are given as a number followed by a unit, or the word "auto".

- `N%`: N percent of the session's width or height.

- `auto`: The image's inherent size will be used to determine an appropriate dimension.

[Inform iTerm2](https://www.iterm2.com/documentation-escape-codes.html) of the current directory to help semantic history and enable [Cmd-clicking relative paths](https://coderwall.com/p/b7e82q/quickly-open-files-in-iterm-with-cmd-click).

Creates an escape code to display an "annotation" in iTerm2.

An annotation looks like this when shown:

See the [iTerm Proprietary Escape Codes documentation](https://iterm2.com/documentation-escape-codes.html) for more information.

The message to display within the annotation.

The `|` character is disallowed and will be stripped.

		@@ -203,2 +203,12 @@ /* eslint-disable @typescript-eslint/member-ordering */
		/**
		Enter the [alternative screen](https://terminalguide.namepad.de/mode/p47/).
		*/
		enterAlternativeScreen: string;

		/**
		Exit the [alternative screen](https://terminalguide.namepad.de/mode/p47/), assuming `enterAlternativeScreen` was called before.
		*/
		exitAlternativeScreen: string;

		/**
		Output a beeping sound.
		@@ -205,0 +215,0 @@ */

		@@ -100,2 +100,5 @@ import process from 'node:process';

		ansiEscapes.enterAlternativeScreen = ESC + '?1049h';
		ansiEscapes.exitAlternativeScreen = ESC + '?1049l';

		ansiEscapes.beep = BEL;
		@@ -102,0 +105,0 @@

		{
		"name": "ansi-escapes",
		"version": "6.1.0",
		"version": "6.2.0",
		"description": "ANSI escape codes for manipulating the terminal",
		@@ -5,0 +5,0 @@ "license": "MIT",

		@@ -137,2 +137,10 @@ # ansi-escapes

		### enterAlternativeScreen

		Enter the [alternative screen](https://terminalguide.namepad.de/mode/p47/).

		### exitAlternativeScreen

		Exit the [alternative screen](https://terminalguide.namepad.de/mode/p47/), assuming `enterAlternativeScreen` was called before.

		### beep
		@@ -139,0 +147,0 @@

New alerts

Fixed alerts

Improved metrics