@peteanderson/ansi 2.3.1 → 3.1.0

package/src/features/types.ts

@@ -5,7 +5,7 @@ export type ColorDepth = 1 | 3 | 4 | 8 | 24;
 export interface Features {
 	colorDepth : ColorDepth;
 	style      : boolean;
-	caret      : boolean;
+	cursor     : boolean;
 	erase      : boolean;
 	scroll     : boolean;
 	terminal   : boolean;

package/src/scroll.ts

@@ -1,13 +1,15 @@
+import {count, noop} from "./utils";
+
 const scroll = {
-	up   : (lines?: number): string => `\x1b[${lines ?? 1}S`,
-	down : (lines?: number): string => `\x1b[${lines ?? 1}T`,
+	up   : count<[lines?: number]>("S"),
+	down : count<[lines?: number]>("T"),
 };
 
 export type Scroll = typeof scroll;
 
 const disabled: Scroll = {
-	up   : () => "",
-	down : () => "",
+	up   : noop,
+	down : noop,
 };
 
 export const makeScroll = (enabled = true): Scroll => enabled ? scroll : disabled;

package/src/sgr/color/channel.ts

@@ -1,3 +1,4 @@
+import {csi}               from "../../utils";
 import {lazy}              from "../lazy";
 import {buildContext}      from "./context";
 import {makeRGB, makeX256} from "./rgb";
@@ -29,7 +30,7 @@ export function makeChannel(
 	const rtn = {
 		rgb     : makeRGB(ctx),
 		x256    : makeX256(ctx),
-		default : colorDepth > 1 ? `\x1b[${close}m` : "",
+		default : colorDepth > 1 ? csi(close, "m") : "",
 	} as Channel;
 
 	for (let i = 0; i < colors.length; i++) {

package/src/sgr/format-builder.ts

@@ -1,4 +1,5 @@
 import {define}       from "@peteanderson/props";
+import {csi}          from "../utils";
 import {combineCodes} from "./combine";
 import {lazy}         from "./lazy";
 
@@ -19,8 +20,8 @@ export const makeFormatBuilder = (makeChain: ChainBuilder): FormatBuilder =>
 		const empty         = Array.isArray(open) && !open.length;
 		const openCode      = empty ? "" : codeSequence(open);
 		const closeCode     = empty ? "" : codeSequence(close);
-		const openSequence  = empty ? "" :`\x1b[${openCode}m`;
-		const closeSequence = empty ? "" :`\x1b[${closeCode}m`;
+		const openSequence  = empty ? "" : csi(openCode, "m");
+		const closeSequence = empty ? "" : csi(closeCode, "m");
 		const reopenCode    = reset && !empty ? `${closeCode};${openCode}` : openCode;
 
 		const rxClose = new RegExp(

package/src/sgr/reset.ts

@@ -1 +1,3 @@
-export const makeReset = (enabled = true): string => enabled ? "\x1b[m" : "";
+import {csi} from "../utils";
+
+export const makeReset = (enabled = true): string => enabled ? csi("m") : "";

package/src/simplify/simplify.ts

@@ -1,4 +1,5 @@
 import {rxSGR} from "../patterns";
+import {csi}   from "../utils";
 import {State} from "./state";
 
 export function simplify(text: string): string {
@@ -20,7 +21,7 @@ export function simplify(text: string): string {
 
 		const newCodes = state.update(codes);
 		if (newCodes.length)
-			result += `\x1b[${newCodes.join(";")}m`;
+			result += csi(newCodes.join(";"), "m");
 		result += chunk;
 	}
 

package/src/slice.ts

@@ -2,7 +2,7 @@ import {rxCSI, rxSGR}  from "./patterns";
 import {simplify}      from "./simplify";
 import {visibleLength} from "./strip";
 
-function scanCSI(
+export function scanCSI(
 	text            : string,
 	fromStringIndex : number,
 	visibleCount    : number,

package/src/split-at.ts

@@ -0,0 +1,32 @@
+import {scanCSI} from "./slice";
+
+import type {slice} from "./slice";
+
+/**
+ * Split a string into two parts at the given visible index (i.e., the given visible character,
+ * ignoring ANSI escape codes). The returned strings will include any ANSI escape codes from within
+ * each slice.
+ *
+ * Note that unlike {@linkcode slice}, this function does not include any SGR codes (m) from before
+ * or after the split point. If you need to preserve the terminal state before and after the split,
+ * use {@linkcode slice} instead.
+ */
+export function splitAt(text: string, visibleIndex: number): [start: string, end: string] {
+	if (!visibleIndex)
+		return ["", text];
+
+	if (visibleIndex < 0)
+		throw new Error("visibleIndex must be non-negative");
+
+	if (visibleIndex > text.length)
+		return [text, ""];
+
+	const {index} = scanCSI(text, 0, visibleIndex);
+
+	if (index === text.length)
+		return [text, ""];
+
+	return [text.slice(0, index), text.slice(index)];
+}
+
+export type SplitAt = typeof splitAt;

package/src/terminal.ts

@@ -1,26 +1,28 @@
+import {csi} from "./utils";
+
 const terminal = {
 	focusReporting: {
-		enable  : "\x1b[?1004h",
-		disable : "\x1b[?1004l",
-		focus   : "\x1b[I",
-		blur    : "\x1b[O",
+		enable  : csi("?1004h"),
+		disable : csi("?1004l"),
+		focus   : csi("I"),
+		blur    : csi("O"),
 	},
 
 	alternateScreen: {
-		enable  : "\x1b[?1049h",
-		disable : "\x1b[?1049l",
+		enable  : csi("?1049h"),
+		disable : csi("?1049l"),
 
 		legacy: {
-			enable  : "\x1b[?47h",
-			disable : "\x1b[?47l",
+			enable  : csi("?47h"),
+			disable : csi("?47l"),
 		},
 	},
 
 	bracketedPaste: {
-		enable  : "\x1b[?2004h",
-		disable : "\x1b[?2004l",
-		start   : "\x1b[200~",
-		end     : "\x1b[201~",
+		enable  : csi("?2004h"),
+		disable : csi("?2004l"),
+		start   : csi("200~"),
+		end     : csi("201~"),
 	},
 };
 

package/src/types.ts

@@ -1,4 +1,4 @@
-import type {Caret}                          from "./caret";
+import type {Cursor}                         from "./cursor";
 import type {Erase}                          from "./erase";
 import type {Features}                       from "./features";
 import type {PadEnd, PadStart}               from "./pad";
@@ -6,11 +6,12 @@ import type {Scroll}                         from "./scroll";
 import type {SGR}                            from "./sgr";
 import type {Simplify}                       from "./simplify";
 import type {Slice}                          from "./slice";
+import type {SplitAt}                        from "./split-at";
 import type {Sanitize, Strip, VisibleLength} from "./strip";
 import type {Terminal}                       from "./terminal";
 
 export type Ansi = SGR & {
-	caret    : Caret;
+	cursor   : Cursor;
 	erase    : Erase;
 	scroll   : Scroll;
 	terminal : Terminal;
@@ -22,6 +23,7 @@ export type Ansi = SGR & {
 	visibleLength : VisibleLength;
 	sanitize      : Sanitize;
 	slice         : Slice;
+	splitAt       : SplitAt;
 	simplify      : Simplify;
 
 	features : Features;

package/src/utils.ts

@@ -0,0 +1,15 @@
+export function csi(command: string): string;
+export function csi(params: string | number | undefined, command: string): string;
+export function csi(...args: [string] | [string | number | undefined, string]): string {
+	const command = args.pop() as string;
+	const params  = args.pop();
+
+	return `\x1b[${params === undefined ? "" : params}${command}`;
+}
+
+export const count = <Param extends [number?] = [count?: number]>(
+	code: string
+): (...args: Param) => string =>
+	(count?: number): string => count === 0 ? "" : csi(count === 1 ? undefined : count, code);
+
+export const noop = () => "";

package/dist/cjs/caret.d.ts

@@ -1,30 +0,0 @@
-declare const caret: {
-    up: (count?: number) => string;
-    down: (count?: number) => string;
-    forward: (count?: number) => string;
-    backward: (count?: number) => string;
-    nextLine: (count?: number) => string;
-    prevLine: (count?: number) => string;
-    x: (x: number) => string;
-    save: string;
-    restore: string;
-    hide: string;
-    show: string;
-    position: {
-        get: string;
-        set: (x: number, y: number) => string;
-    };
-    shape: {
-        steadyBlock: string;
-        steadyBar: string;
-        steadyUnderline: string;
-        blinkingBlock: string;
-        blinkingBar: string;
-        blinkingUnderline: string;
-        default: string;
-    };
-};
-export type Caret = typeof caret;
-export declare const makeCaret: (enabled?: boolean) => Caret;
-export {};
-//# sourceMappingURL=caret.d.ts.map

package/dist/cjs/caret.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"caret.d.ts","sourceRoot":"","sources":["../../src/caret.ts"],"names":[],"mappings":"AAKA,QAAA,MAAM,KAAK;iBAL6B,MAAM,KAAG,MAAM;mBAAf,MAAM,KAAG,MAAM;sBAAf,MAAM,KAAG,MAAM;uBAAf,MAAM,KAAG,MAAM;uBAAf,MAAM,KAAG,MAAM;uBAAf,MAAM,KAAG,MAAM;WAa/C,MAAM,KAAG,MAAM;;;;;;;iBAkBZ,MAAM,KAAK,MAAM,KAAG,MAAM;;;;;;;;;;;CAYpC,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC;AAkCjC,eAAO,MAAM,SAAS,GAAI,iBAAc,KAAG,KAAmC,CAAC"}

package/dist/cjs/caret.js

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeCaret = void 0;
-const move = (code) => (count) => `\x1b[${count === undefined ? "" : count ? count : "?"}${code}`;
-const noop = () => "";
-const caret = {
-    up: move("A"),
-    down: move("B"),
-    forward: move("C"),
-    backward: move("D"),
-    nextLine: move("E"),
-    prevLine: move("F"),
-    x: (x) => `\x1b[${x}G`,
-    // These are the old VT100 codes, but they're widely supported by old and new terminals. The
-    // newer VT220 codes are standardized by ECMA and ISO, and are also widely supported, but might
-    // not work in some older terminals. The VT220 codes are:
-    //
-    // ```
-    // save    : "\x1b[s",
-    // restore : "\x1b[u",
-    // ```
-    save: "\x1b7",
-    restore: "\x1b8",
-    hide: "\x1b[?25l",
-    show: "\x1b[?25h",
-    position: {
-        get: "\x1b[6n",
-        set: (x, y) => `\x1b[${y};${x}H`,
-    },
-    shape: {
-        steadyBlock: "\x1b[2 q",
-        steadyBar: "\x1b[6 q",
-        steadyUnderline: "\x1b[4 q",
-        blinkingBlock: "\x1b[1 q",
-        blinkingBar: "\x1b[5 q",
-        blinkingUnderline: "\x1b[3 q",
-        default: "\x1b[0 q",
-    },
-};
-const disabled = {
-    up: noop,
-    down: noop,
-    forward: noop,
-    backward: noop,
-    nextLine: noop,
-    prevLine: noop,
-    x: noop,
-    save: "",
-    restore: "",
-    hide: "",
-    show: "",
-    position: {
-        get: "",
-        set: noop,
-    },
-    shape: {
-        steadyBlock: "",
-        steadyBar: "",
-        steadyUnderline: "",
-        blinkingBlock: "",
-        blinkingBar: "",
-        blinkingUnderline: "",
-        default: "",
-    },
-};
-const makeCaret = (enabled = true) => enabled ? caret : disabled;
-exports.makeCaret = makeCaret;
-//# sourceMappingURL=caret.js.map

package/dist/cjs/caret.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"caret.js","sourceRoot":"","sources":["../../src/caret.ts"],"names":[],"mappings":";;;AAAA,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,KAAc,EAAU,EAAE,CACzD,QAAQ,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC;AAEjE,MAAM,IAAI,GAAG,GAAW,EAAE,CAAC,EAAE,CAAC;AAE9B,MAAM,KAAK,GAAG;IACb,EAAE,EAAS,IAAI,CAAC,GAAG,CAAC;IACpB,IAAI,EAAO,IAAI,CAAC,GAAG,CAAC;IACpB,OAAO,EAAI,IAAI,CAAC,GAAG,CAAC;IACpB,QAAQ,EAAG,IAAI,CAAC,GAAG,CAAC;IACpB,QAAQ,EAAG,IAAI,CAAC,GAAG,CAAC;IACpB,QAAQ,EAAG,IAAI,CAAC,GAAG,CAAC;IAEpB,CAAC,EAAE,CAAC,CAAS,EAAU,EAAE,CAAC,QAAQ,CAAC,GAAG;IAEtC,4FAA4F;IAC5F,+FAA+F;IAC/F,yDAAyD;IACzD,EAAE;IACF,MAAM;IACN,sBAAsB;IACtB,sBAAsB;IACtB,MAAM;IACN,IAAI,EAAM,OAAO;IACjB,OAAO,EAAG,OAAO;IAEjB,IAAI,EAAG,WAAW;IAClB,IAAI,EAAG,WAAW;IAElB,QAAQ,EAAE;QACT,GAAG,EAAE,SAAS;QACd,GAAG,EAAE,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG;KACxD;IAED,KAAK,EAAE;QACN,WAAW,EAAS,UAAU;QAC9B,SAAS,EAAW,UAAU;QAC9B,eAAe,EAAK,UAAU;QAC9B,aAAa,EAAO,UAAU;QAC9B,WAAW,EAAS,UAAU;QAC9B,iBAAiB,EAAG,UAAU;QAC9B,OAAO,EAAa,UAAU;KAC9B;CACD,CAAC;AAIF,MAAM,QAAQ,GAAU;IACvB,EAAE,EAAS,IAAI;IACf,IAAI,EAAO,IAAI;IACf,OAAO,EAAI,IAAI;IACf,QAAQ,EAAG,IAAI;IACf,QAAQ,EAAG,IAAI;IACf,QAAQ,EAAG,IAAI;IAEf,CAAC,EAAE,IAAI;IAEP,IAAI,EAAM,EAAE;IACZ,OAAO,EAAG,EAAE;IAEZ,IAAI,EAAG,EAAE;IACT,IAAI,EAAG,EAAE;IAET,QAAQ,EAAE;QACT,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,IAAI;KACT;IAED,KAAK,EAAE;QACN,WAAW,EAAS,EAAE;QACtB,SAAS,EAAW,EAAE;QACtB,eAAe,EAAK,EAAE;QACtB,aAAa,EAAO,EAAE;QACtB,WAAW,EAAS,EAAE;QACtB,iBAAiB,EAAG,EAAE;QACtB,OAAO,EAAa,EAAE;KACtB;CACD,CAAC;AAEK,MAAM,SAAS,GAAG,CAAC,OAAO,GAAG,IAAI,EAAS,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAAlE,QAAA,SAAS,aAAyD"}

package/dist/esm/caret.d.ts

@@ -1,30 +0,0 @@
-declare const caret: {
-    up: (count?: number) => string;
-    down: (count?: number) => string;
-    forward: (count?: number) => string;
-    backward: (count?: number) => string;
-    nextLine: (count?: number) => string;
-    prevLine: (count?: number) => string;
-    x: (x: number) => string;
-    save: string;
-    restore: string;
-    hide: string;
-    show: string;
-    position: {
-        get: string;
-        set: (x: number, y: number) => string;
-    };
-    shape: {
-        steadyBlock: string;
-        steadyBar: string;
-        steadyUnderline: string;
-        blinkingBlock: string;
-        blinkingBar: string;
-        blinkingUnderline: string;
-        default: string;
-    };
-};
-export type Caret = typeof caret;
-export declare const makeCaret: (enabled?: boolean) => Caret;
-export {};
-//# sourceMappingURL=caret.d.ts.map

package/dist/esm/caret.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"caret.d.ts","sourceRoot":"","sources":["../../src/caret.ts"],"names":[],"mappings":"AAKA,QAAA,MAAM,KAAK;iBAL6B,MAAM,KAAG,MAAM;mBAAf,MAAM,KAAG,MAAM;sBAAf,MAAM,KAAG,MAAM;uBAAf,MAAM,KAAG,MAAM;uBAAf,MAAM,KAAG,MAAM;uBAAf,MAAM,KAAG,MAAM;WAa/C,MAAM,KAAG,MAAM;;;;;;;iBAkBZ,MAAM,KAAK,MAAM,KAAG,MAAM;;;;;;;;;;;CAYpC,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC;AAkCjC,eAAO,MAAM,SAAS,GAAI,iBAAc,KAAG,KAAmC,CAAC"}

package/dist/esm/caret.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"caret.js","sourceRoot":"","sources":["../../src/caret.ts"],"names":[],"mappings":"AAAA,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,KAAc,EAAU,EAAE,CACzD,QAAQ,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC;AAEjE,MAAM,IAAI,GAAG,GAAW,EAAE,CAAC,EAAE,CAAC;AAE9B,MAAM,KAAK,GAAG;IACb,EAAE,EAAS,IAAI,CAAC,GAAG,CAAC;IACpB,IAAI,EAAO,IAAI,CAAC,GAAG,CAAC;IACpB,OAAO,EAAI,IAAI,CAAC,GAAG,CAAC;IACpB,QAAQ,EAAG,IAAI,CAAC,GAAG,CAAC;IACpB,QAAQ,EAAG,IAAI,CAAC,GAAG,CAAC;IACpB,QAAQ,EAAG,IAAI,CAAC,GAAG,CAAC;IAEpB,CAAC,EAAE,CAAC,CAAS,EAAU,EAAE,CAAC,QAAQ,CAAC,GAAG;IAEtC,4FAA4F;IAC5F,+FAA+F;IAC/F,yDAAyD;IACzD,EAAE;IACF,MAAM;IACN,sBAAsB;IACtB,sBAAsB;IACtB,MAAM;IACN,IAAI,EAAM,OAAO;IACjB,OAAO,EAAG,OAAO;IAEjB,IAAI,EAAG,WAAW;IAClB,IAAI,EAAG,WAAW;IAElB,QAAQ,EAAE;QACT,GAAG,EAAE,SAAS;QACd,GAAG,EAAE,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG;KACxD;IAED,KAAK,EAAE;QACN,WAAW,EAAS,UAAU;QAC9B,SAAS,EAAW,UAAU;QAC9B,eAAe,EAAK,UAAU;QAC9B,aAAa,EAAO,UAAU;QAC9B,WAAW,EAAS,UAAU;QAC9B,iBAAiB,EAAG,UAAU;QAC9B,OAAO,EAAa,UAAU;KAC9B;CACD,CAAC;AAIF,MAAM,QAAQ,GAAU;IACvB,EAAE,EAAS,IAAI;IACf,IAAI,EAAO,IAAI;IACf,OAAO,EAAI,IAAI;IACf,QAAQ,EAAG,IAAI;IACf,QAAQ,EAAG,IAAI;IACf,QAAQ,EAAG,IAAI;IAEf,CAAC,EAAE,IAAI;IAEP,IAAI,EAAM,EAAE;IACZ,OAAO,EAAG,EAAE;IAEZ,IAAI,EAAG,EAAE;IACT,IAAI,EAAG,EAAE;IAET,QAAQ,EAAE;QACT,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,IAAI;KACT;IAED,KAAK,EAAE;QACN,WAAW,EAAS,EAAE;QACtB,SAAS,EAAW,EAAE;QACtB,eAAe,EAAK,EAAE;QACtB,aAAa,EAAO,EAAE;QACtB,WAAW,EAAS,EAAE;QACtB,iBAAiB,EAAG,EAAE;QACtB,OAAO,EAAa,EAAE;KACtB;CACD,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAO,GAAG,IAAI,EAAS,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC"}

package/src/caret.ts

@@ -1,80 +0,0 @@
-const move = (code: string) => (count?: number): string =>
-	`\x1b[${count === undefined ? "" : count ? count : "?"}${code}`;
-
-const noop = (): string => "";
-
-const caret = {
-	up       : move("A"),
-	down     : move("B"),
-	forward  : move("C"),
-	backward : move("D"),
-	nextLine : move("E"),
-	prevLine : move("F"),
-
-	x: (x: number): string => `\x1b[${x}G`,
-
-	// These are the old VT100 codes, but they're widely supported by old and new terminals. The
-	// newer VT220 codes are standardized by ECMA and ISO, and are also widely supported, but might
-	// not work in some older terminals. The VT220 codes are:
-	//
-	// ```
-	// save    : "\x1b[s",
-	// restore : "\x1b[u",
-	// ```
-	save    : "\x1b7",
-	restore : "\x1b8",
-
-	hide : "\x1b[?25l",
-	show : "\x1b[?25h",
-
-	position: {
-		get: "\x1b[6n",
-		set: (x: number, y: number): string => `\x1b[${y};${x}H`,
-	},
-
-	shape: {
-		steadyBlock       : "\x1b[2 q",
-		steadyBar         : "\x1b[6 q",
-		steadyUnderline   : "\x1b[4 q",
-		blinkingBlock     : "\x1b[1 q",
-		blinkingBar       : "\x1b[5 q",
-		blinkingUnderline : "\x1b[3 q",
-		default           : "\x1b[0 q",
-	},
-};
-
-export type Caret = typeof caret;
-
-const disabled: Caret = {
-	up       : noop,
-	down     : noop,
-	forward  : noop,
-	backward : noop,
-	nextLine : noop,
-	prevLine : noop,
-
-	x: noop,
-
-	save    : "",
-	restore : "",
-
-	hide : "",
-	show : "",
-
-	position: {
-		get: "",
-		set: noop,
-	},
-
-	shape: {
-		steadyBlock       : "",
-		steadyBar         : "",
-		steadyUnderline   : "",
-		blinkingBlock     : "",
-		blinkingBar       : "",
-		blinkingUnderline : "",
-		default           : "",
-	},
-};
-
-export const makeCaret = (enabled = true): Caret => enabled ? caret : disabled;