@peteanderson/ansi 0.3.3 → 1.0.1

package/dist/slice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slice.js","sourceRoot":"","sources":["../src/slice.ts"],"names":[],"mappings":";;AAwDA,sBA6BC;AArFD,yCAAyC;AACzC,yCAAyC;AACzC,mCAAsC;AAEtC,SAAS,OAAO,CACf,IAAwB,EACxB,eAAwB,EACxB,YAAwB;IAExB,gEAAgE;IAChE,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,gBAAK,CAAC,CAAC;IAE7B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,KAAK,GAAI,eAAe,CAAC;IAE7B,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,IAAI,MAAM,GAAG,YAAY,EAAE,CAAC;QACrD,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,MAAM,EAAE,CAAC;YAC5B,EAAE,CAAC,SAAS,GAAG,KAAK,CAAC;YACrB,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,KAAK,EAAE,KAAK,KAAK,KAAK,EAAE,CAAC;gBAC5B,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBACzB,SAAS;YACV,CAAC;QACF,CAAC;QAED,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;IACV,CAAC;IAED,OAAO,EAAC,KAAK,EAAE,MAAM,EAAC,CAAC;AACxB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY,EAAE,KAAa,EAAE,GAAY;IAClE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,gBAAK,CAAC,CAAC,CAAC;IAClE,OAAO,SAAS,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,KAAK,CAAC,IAAY,EAAE,KAAa,EAAE,GAAW;IAC7D,IAAI,iBAAqC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,iBAAiB,KAAjB,iBAAiB,GAAK,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAA,CAAC;IAEzE,IAAI,KAAK,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QAC1B,iBAAiB,GAAG,gBAAgB,EAAE,CAAC;QACvC,IAAI,KAAK,GAAG,CAAC;YACZ,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC,CAAC;QAChD,IAAI,GAAG,GAAG,CAAC;YACV,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,iBAAiB,GAAG,GAAG,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,KAAK,GAAG,GAAG;QACd,OAAO,EAAE,CAAC;IAEX,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC;IAEb,MAAM,EAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAE5E,MAAM,QAAQ,GACb,UAAU,GAAG,IAAI,CAAC,MAAM,IAAI,cAAc,GAAG,GAAG;QAC/C,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC,KAAK;QACvD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IAEhB,mGAAmG;IACnG,MAAM,gBAAgB,GAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;IAChE,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAE3D,OAAO,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,iBAAiB,CAAC;AAChF,CAAC"}

package/dist/strip.d.ts

@@ -1,15 +1,7 @@
-/**
- * Remove all ANSI escape codes from the given text.
- * @type {(text: string) => string}
- */
-export const strip: (text: string) => string;
-/**
- * Calculate the visible length of a string with ANSI escape codes stripped.
- * @type {(text: string) => number}
- */
-export const visibleLength: (text: string) => number;
-/**
- * Remove all ANSI escape codes except SGR codes (m), which are used for color and styling.
- * @type {(text: string) => string}
- */
-export const sanitize: (text: string) => string;
+/** Remove all ANSI escape codes from the given text. */
+export declare const strip: (text: string) => string;
+/** Calculate the visible length of a string with ANSI escape codes stripped. */
+export declare const visibleLength: (text: string) => number;
+/** Remove all ANSI escape codes except SGR codes (m), which are used for color and styling. */
+export declare const sanitize: (text: string) => string;
+//# sourceMappingURL=strip.d.ts.map

package/dist/strip.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strip.d.ts","sourceRoot":"","sources":["../src/strip.ts"],"names":[],"mappings":"AAEA,wDAAwD;AACxD,eAAO,MAAM,KAAK,GAAY,MAAM,MAAM,KAAG,MAA6C,CAAC;AAE3F,gFAAgF;AAChF,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,KAAG,MAA4B,CAAC;AAE1E,+FAA+F;AAC/F,eAAO,MAAM,QAAQ,GAAS,MAAM,MAAM,KAAG,MAAgD,CAAC"}

package/dist/strip.js

@@ -1,18 +1,14 @@
 "use strict";
-const { rxCSI, rxUnsafe } = require("./patterns");
-/**
- * Remove all ANSI escape codes from the given text.
- * @type {(text: string) => string}
- */
-const strip = text => text.replace(new RegExp(rxCSI), "");
-/**
- * Calculate the visible length of a string with ANSI escape codes stripped.
- * @type {(text: string) => number}
- */
-const visibleLength = text => strip(text).length;
-/**
- * Remove all ANSI escape codes except SGR codes (m), which are used for color and styling.
- * @type {(text: string) => string}
- */
-const sanitize = text => text.replace(new RegExp(rxUnsafe), "");
-module.exports = { strip, visibleLength, sanitize };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitize = exports.visibleLength = exports.strip = void 0;
+const patterns_1 = require("./patterns");
+/** Remove all ANSI escape codes from the given text. */
+const strip = (text) => text.replace(new RegExp(patterns_1.rxCSI), "");
+exports.strip = strip;
+/** Calculate the visible length of a string with ANSI escape codes stripped. */
+const visibleLength = (text) => (0, exports.strip)(text).length;
+exports.visibleLength = visibleLength;
+/** Remove all ANSI escape codes except SGR codes (m), which are used for color and styling. */
+const sanitize = (text) => text.replace(new RegExp(patterns_1.rxUnsafe), "");
+exports.sanitize = sanitize;
+//# sourceMappingURL=strip.js.map

package/dist/strip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strip.js","sourceRoot":"","sources":["../src/strip.ts"],"names":[],"mappings":";;;AAAA,yCAA2C;AAE3C,wDAAwD;AACjD,MAAM,KAAK,GAAW,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,gBAAK,CAAC,EAAE,EAAE,CAAC,CAAC;AAA9E,QAAA,KAAK,SAAyE;AAE3F,gFAAgF;AACzE,MAAM,aAAa,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC,CAAC,MAAM,CAAC;AAA7D,QAAA,aAAa,iBAAgD;AAE1E,+FAA+F;AACxF,MAAM,QAAQ,GAAQ,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,mBAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;AAAjF,QAAA,QAAQ,YAAyE"}

package/dist/terminal.d.ts

@@ -1,4 +1,4 @@
-export function makeTerminal(enabled?: boolean): {
+declare const terminal: {
     focusReporting: {
         enable: string;
         disable: string;
@@ -20,3 +20,7 @@ export function makeTerminal(enabled?: boolean): {
         end: string;
     };
 };
+export type Terminal = typeof terminal;
+export declare const makeTerminal: (enabled?: boolean) => Terminal;
+export {};
+//# sourceMappingURL=terminal.d.ts.map

package/dist/terminal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminal.d.ts","sourceRoot":"","sources":["../src/terminal.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;CAwBb,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC;AA4BvC,eAAO,MAAM,YAAY,GAAI,iBAAc,KAAG,QAAyC,CAAC"}

package/dist/terminal.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeTerminal = void 0;
 const terminal = {
     focusReporting: {
         enable: "\x1b[?1004h",
@@ -21,7 +23,6 @@ const terminal = {
         end: "\x1b[201~",
     },
 };
-/** @type {typeof terminal} */
 const disabled = {
     focusReporting: {
         enable: "",
@@ -45,4 +46,5 @@ const disabled = {
     },
 };
 const makeTerminal = (enabled = true) => enabled ? terminal : disabled;
-module.exports = { makeTerminal };
+exports.makeTerminal = makeTerminal;
+//# sourceMappingURL=terminal.js.map

package/dist/terminal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminal.js","sourceRoot":"","sources":["../src/terminal.ts"],"names":[],"mappings":";;;AAAA,MAAM,QAAQ,GAAG;IAChB,cAAc,EAAE;QACf,MAAM,EAAI,aAAa;QACvB,OAAO,EAAG,aAAa;QACvB,KAAK,EAAK,QAAQ;QAClB,IAAI,EAAM,QAAQ;KAClB;IAED,eAAe,EAAE;QAChB,MAAM,EAAI,aAAa;QACvB,OAAO,EAAG,aAAa;QAEvB,MAAM,EAAE;YACP,MAAM,EAAI,WAAW;YACrB,OAAO,EAAG,WAAW;SACrB;KACD;IAED,cAAc,EAAE;QACf,MAAM,EAAI,aAAa;QACvB,OAAO,EAAG,aAAa;QACvB,KAAK,EAAK,WAAW;QACrB,GAAG,EAAO,WAAW;KACrB;CACD,CAAC;AAIF,MAAM,QAAQ,GAAa;IAC1B,cAAc,EAAE;QACf,MAAM,EAAI,EAAE;QACZ,OAAO,EAAG,EAAE;QACZ,KAAK,EAAK,EAAE;QACZ,IAAI,EAAM,EAAE;KACZ;IAED,eAAe,EAAE;QAChB,MAAM,EAAI,EAAE;QACZ,OAAO,EAAG,EAAE;QAEZ,MAAM,EAAE;YACP,MAAM,EAAI,EAAE;YACZ,OAAO,EAAG,EAAE;SACZ;KACD;IAED,cAAc,EAAE;QACf,MAAM,EAAI,EAAE;QACZ,OAAO,EAAG,EAAE;QACZ,KAAK,EAAK,EAAE;QACZ,GAAG,EAAO,EAAE;KACZ;CACD,CAAC;AAEK,MAAM,YAAY,GAAG,CAAC,OAAO,GAAG,IAAI,EAAY,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;AAA3E,QAAA,YAAY,gBAA+D"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name"            : "@peteanderson/ansi",
-	"version"         : "0.3.3",
+	"version"         : "1.0.1",
 	"description"     : "ANSI escape sequence generation with automatic feature detection",
 	"author"          : {
 		"name"  : "Pete Anderson",
@@ -13,12 +13,12 @@
 	"keywords"        : ["ansi", "nodejs", "color", "terminal", "cli"],
 	"engines"         : {"node": ">=18"},
 	"files"           : ["dist", "src"],
-	"main"            : "dist/ansi.js",
-	"types"           : "dist/ansi.d.ts",
+	"main"            : "dist/index.js",
+	"types"           : "dist/index.d.ts",
 	"exports"         : {
 		".": {
-			"types"   : "./dist/ansi.d.ts",
-			"require" : "./dist/ansi.js"
+			"types"   : "./dist/index.d.ts",
+			"require" : "./dist/index.js"
 		}
 	},
 	"license"         : "MIT",
@@ -26,10 +26,12 @@
 		"prebuild" : "node -e \"require('node:fs').rmSync('dist', {force: true, recursive: true})\"",
 		"build"    : "tsc -p tsconfig.build.json",
 		"prepack"  : "npm run build",
-		"tag"      : "git tag -a v$npm_package_version -m v$npm_package_version"
+		"tag"      : "git tag -a v$npm_package_version -m v$npm_package_version",
+		"tag-all"  : "tsx --tsconfig scripts/tsconfig.json scripts/tag-all.ts"
 	},
 	"devDependencies" : {
 		"@types/node" : "^26.0.0",
+		"tsx"         : "^4.22.4",
 		"typescript"  : "^6.0.3"
 	}
 }

package/src/ansi.ts

@@ -0,0 +1,71 @@
+import {makeCaret}                       from "./caret";
+import {makeErase}                       from "./erase";
+import {getFeatures}                     from "./features";
+import {padEnd, padStart}                from "./pad";
+import {makeScroll}                      from "./scroll";
+import {makeColor, makeReset, makeStyle} from "./sgr";
+import {simplify}                        from "./simplify";
+import {slice}                           from "./slice";
+import {sanitize, strip, visibleLength}  from "./strip";
+import {makeTerminal}                    from "./terminal";
+
+import type {Args}         from "./features/features";
+import type {Caret}        from "./caret";
+import type {Erase}        from "./erase";
+import type {Features}     from "./features/types";
+import type {Scroll}       from "./scroll";
+import type {Color, Style} from "./sgr";
+import type {Terminal}     from "./terminal";
+
+export type Ansi = Color & {
+	caret  : Caret;
+	erase  : Erase;
+	scroll : Scroll;
+
+	reset : string;
+	style : Style;
+
+	terminal : Terminal;
+
+	padEnd   : typeof padEnd;
+	padStart : typeof padStart;
+
+	strip         : typeof strip;
+	visibleLength : typeof visibleLength;
+	sanitize      : typeof sanitize;
+	slice         : typeof slice;
+	simplify      : typeof simplify;
+
+	features : Features;
+};
+
+export function makeAnsi(...args: Args): Ansi {
+	const features = getFeatures(...args);
+
+	return {
+		caret  : makeCaret(features.caret),
+		erase  : makeErase(features.erase),
+		scroll : makeScroll(features.scroll),
+
+		reset : makeReset(features.colorDepth > 1),
+		style : makeStyle(features.style),
+		...makeColor(features.colorDepth),
+
+		terminal: makeTerminal(features.terminal),
+
+		padEnd,
+		padStart,
+
+		strip,
+		visibleLength,
+		sanitize,
+		slice,
+		simplify,
+
+		features,
+	};
+}
+
+const ansi = Object.assign(makeAnsi, makeAnsi());
+
+export default ansi;

package/src/{caret.js → caret.ts}

@@ -1,10 +1,7 @@
-"use strict";
+const move = (code: string) => (count?: number): string =>
+	`\x1b[${count === undefined ? "" : count ? count : "?"}${code}`;
 
-/** @type {(code: string) => (count?: number) => string} */
-const move = code => count => `\x1b[${count === undefined ? "" : count ? count : "?"}${code}`;
-
-/** @type {(count?: number) => string} */
-const noop = () => "";
+const noop = (): string => "";
 
 const caret = {
 	up       : move("A"),
@@ -14,8 +11,7 @@ const caret = {
 	nextLine : move("E"),
 	prevLine : move("F"),
 
-	/** @type {(x: number) => string} */
-	x: x => `\x1b[${x}G`,
+	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
@@ -33,8 +29,7 @@ const caret = {
 
 	position: {
 		get: "\x1b[6n",
-		/** @type {(x: number, y: number) => string} */
-		set: (x, y) => `\x1b[${y};${x}H`,
+		set: (x: number, y: number): string => `\x1b[${y};${x}H`,
 	},
 
 	shape: {
@@ -48,8 +43,9 @@ const caret = {
 	},
 };
 
-/** @type {typeof caret} */
-const disabled = {
+export type Caret = typeof caret;
+
+const disabled: Caret = {
 	up       : noop,
 	down     : noop,
 	forward  : noop,
@@ -81,6 +77,4 @@ const disabled = {
 	},
 };
 
-const makeCaret = (enabled = true) => enabled ? caret : disabled;
-
-module.exports = {makeCaret};
+export const makeCaret = (enabled = true): Caret => enabled ? caret : disabled;

package/src/{erase.js → erase.ts}

@@ -1,10 +1,8 @@
-"use strict";
-
 const erase = {
 	line: {
-		toStart: "\x1b[1K",
-		toEnd  : "\x1b[0K",
-		full   : "\x1b[2K",
+		toStart : "\x1b[1K",
+		toEnd   : "\x1b[0K",
+		full    : "\x1b[2K",
 	},
 	screen: {
 		toStart    : "\x1b[1J",
@@ -14,8 +12,9 @@ const erase = {
 	},
 };
 
-/** @type {typeof erase} */
-const disabled = {
+export type Erase = typeof erase;
+
+const disabled: Erase = {
 	line: {
 		toStart : "",
 		toEnd   : "",
@@ -29,6 +28,4 @@ const disabled = {
 	},
 };
 
-const makeErase = (enabled = true) => enabled ? erase : disabled;
-
-module.exports = {makeErase};
+export const makeErase = (enabled = true): Erase => enabled ? erase : disabled;

package/src/features/build.ts

@@ -0,0 +1,53 @@
+import {detectFeatureSupport, getColorDepth} from "./detect";
+
+import type {ColorDepth, Features} from "./types";
+
+function normalizeColorDepth(colorDepth: number): ColorDepth {
+	colorDepth = Math.floor(colorDepth);
+	if (colorDepth >= 24) return 24;
+	if (colorDepth >= 8)  return 8;
+	if (colorDepth >= 4)  return 4;
+	if (colorDepth === 3) return 3;
+	return 1;
+}
+
+export function build(
+	isTTY      : boolean,
+	colorDepth : ColorDepth,
+	style?     : boolean,
+	caret?     : boolean,
+	erase?     : boolean,
+	scroll?    : boolean,
+	terminal?  : boolean,
+): Features {
+	if (
+		style    !== undefined &&
+		caret    !== undefined &&
+		erase    !== undefined &&
+		scroll   !== undefined &&
+		terminal !== undefined
+	)
+		return {colorDepth: normalizeColorDepth(colorDepth), style, caret, erase, scroll, terminal};
+
+	const support = detectFeatureSupport(isTTY, colorDepth);
+	return {
+		colorDepth : normalizeColorDepth(colorDepth),
+		style      : style    ?? support.style,
+		caret      : caret    ?? support.caret,
+		erase      : erase    ?? support.erase,
+		scroll     : scroll   ?? support.scroll,
+		terminal   : terminal ?? support.terminal,
+	};
+}
+
+export const boolean = (isTTY: boolean, enabled: boolean): Features =>
+	build(isTTY, enabled ? 4 : 1);
+
+export const number = (isTTY: boolean, colorDepth: ColorDepth): Features =>
+	build(isTTY, colorDepth);
+
+export const tty = (stream: NodeJS.WriteStream): Features =>
+	build(true, getColorDepth(stream));
+
+export const pipe = (): Features =>
+	build(false, getColorDepth());

package/src/features/detect.ts

@@ -0,0 +1,36 @@
+import type {ColorDepth, Features} from "./types";
+
+export function getColorDepth(stream?: NodeJS.WriteStream): ColorDepth {
+	if (stream?.isTTY)
+		return stream.getColorDepth() as ColorDepth;
+
+	if (process.env.NO_COLOR || process.env.NODE_DISABLE_COLORS)
+		return 1;
+
+	switch (process.env.FORCE_COLOR) {
+		case "":
+		case "true":
+		case "1":
+			return 4;
+		case "2":
+			return 8;
+		case "3":
+			return 24;
+		default:
+			return 1;
+	}
+}
+
+export function detectFeatureSupport(
+	isTTY      : boolean,
+	colorDepth : ColorDepth,
+): Omit<Features, "colorDepth"> {
+	const enabled = process.env.TERM !== "dumb" && isTTY;
+	return {
+		style    : colorDepth > 1,
+		caret    : enabled,
+		erase    : enabled,
+		scroll   : enabled,
+		terminal : enabled,
+	};
+}

package/src/features/{features.js → features.ts}

@@ -1,25 +1,18 @@
-"use strict";
+import {Socket}                            from "node:net";
+import {WriteStream}                       from "node:tty";
+import {boolean, build, number, pipe, tty} from "./build";
+import {getColorDepth}                     from "./detect";
 
-const {Socket}                            = require("node:net");
-const {WriteStream}                       = require("node:tty");
-const {build, boolean, number, tty, pipe} = require("./build");
-const {getColorDepth}                     = require("./detect");
+import type {ColorDepth, Features} from "./types";
 
-/**
-@typedef {import("./types").ColorDepth} ColorDepth
-@typedef {import("./types").Features}   Features
-
-@typedef {
+export type Args =
 	| [enabled    : boolean,           stream?: NodeJS.WriteStream]
 	| [colorDepth : ColorDepth,        stream?: NodeJS.WriteStream]
 	| [features   : Partial<Features>, stream?: NodeJS.WriteStream]
 	| [socket     : Socket]
-	| [stream?    : NodeJS.WriteStream]
-} Args
-*/
+	| [stream?    : NodeJS.WriteStream];
 
-/** @type {(...args: Args) => Features} */
-function getFeatures(...args) {
+export function getFeatures(...args: Args): Features {
 	let [features, stream] = args;
 
 	if (typeof features === "boolean")
@@ -48,6 +41,4 @@ function getFeatures(...args) {
 		return build(true, getColorDepth(stream), style, caret, erase, scroll, terminal);
 
 	return build(false, getColorDepth(), style, caret, erase, scroll, terminal);
-}
-
-module.exports = {getFeatures};
+}

package/src/features/index.ts

@@ -0,0 +1 @@
+export * from "./features";

package/src/index.ts

@@ -0,0 +1,2 @@
+export {default} from "./ansi";
+export *         from "./ansi";

package/src/{pad.js → pad.ts}

@@ -1,21 +1,15 @@
-"use strict";
-
-const {visibleLength} = require("./strip");
+import {visibleLength} from "./strip";
 
 /**
  * Pad the given text at the end with the specified fill string to the target visible length without
  * counting ANSI escape codes.
- * @type {(text: string, targetLength: number, fillString?: string) => string}
  */
-const padEnd = (text, targetLength, fillString = " ") =>
+export const padEnd = (text: string, targetLength: number, fillString = " "): string =>
 	text + fillString.repeat(Math.max(0, targetLength - visibleLength(text)) / fillString.length);
 
 /**
  * Pad the given text at the start with the specified fill string to the target visible length
  * without counting ANSI escape codes.
- * @type {(text: string, targetLength: number, fillString?: string) => string}
  */
-const padStart = (text, targetLength, fillString = " ") =>
-	fillString.repeat(Math.max(0, targetLength - visibleLength(text)) / fillString.length) + text;
-
-module.exports = {padEnd, padStart};
+export const padStart = (text: string, targetLength: number, fillString = " "): string =>
+	fillString.repeat(Math.max(0, targetLength - visibleLength(text)) / fillString.length) + text;

package/src/{patterns.js → patterns.ts}

@@ -37,8 +37,6 @@ timeit(() => long .replace(new RegExp(rxSGR.source, "g"), ""), {description: "lo
 ```
 */
 
-const rxSGR    = Object.freeze(/\x1b\[[\d;]*m/g);
-const rxCSI    = Object.freeze(/\x1b\[[0-?]*[ -/]*[@-~]/g);
-const rxUnsafe = Object.freeze(/\x1b\[[0-?]*[ -/]*[@-ln-~]/g); // Everything except SGR codes (m).
-
-module.exports = {rxSGR, rxCSI, rxUnsafe};
+export const rxSGR    = Object.freeze(/\x1b\[[\d;]*m/g);
+export const rxCSI    = Object.freeze(/\x1b\[[0-?]*[ -/]*[@-~]/g);
+export const rxUnsafe = Object.freeze(/\x1b\[[0-?]*[ -/]*[@-ln-~]/g); // Everything except SGR codes (m).

package/src/scroll.ts

@@ -0,0 +1,13 @@
+const scroll = {
+	up   : (lines?: number): string => `\x1b[${lines ?? 1}S`,
+	down : (lines?: number): string => `\x1b[${lines ?? 1}T`,
+};
+
+export type Scroll = typeof scroll;
+
+const disabled: Scroll = {
+	up   : () => "",
+	down : () => "",
+};
+
+export const makeScroll = (enabled = true): Scroll => enabled ? scroll : disabled;

package/src/sgr/color/{color.js → color.ts}

@@ -1,25 +1,23 @@
-const {makeSGR}                                       = require("../sgr");
-const {makeStyle}                                     = require("../style");
-const {clip, rgbToX256, rgbToX16, rgbToX8, x256ToRgb} = require("./utils");
+import {makeSGR}                                       from "../sgr";
+import {makeStyle}                                     from "../style";
+import {clip, rgbToX16, rgbToX256, rgbToX8, x256ToRgb} from "./utils";
 
-/** @typedef {import("../sgr").Code}                     Code */
-/** @typedef {import("../../features/types").ColorDepth} ColorDepth */
-/** @typedef {import("../sgr").SGR}                      SGR */
-/** @typedef {import("./types").Channel}                 Channel */
+import type {ColorDepth}     from "../../features/types";
+import type {SGR}            from "../sgr";
+import type {Channel, Color} from "./types";
+
+export type {Color} from "./types";
 
 const fgOpen = 30, fgClose = 39;
 const bgOpen = 40, bgClose = 49;
 
-/** @type {(colorDepth: ColorDepth, open: number, close: number) => Channel} */
-function makeChannel(colorDepth, open, close) {
+function makeChannel(colorDepth: ColorDepth, open: number, close: number): Channel {
 	const sgrBase = makeSGR(colorDepth > 1);
 	const style   = makeStyle(colorDepth > 1);
 
-	/** @type {(code: Code) => SGR} */
-	const sgr = code => sgrBase(code, close);
+	const sgr = (code: number | number[]): SGR => sgrBase(code, close);
 
-	/** @type {(index: number) => SGR} */
-	const bright =
+	const bright: (index: number) => SGR =
 		colorDepth >= 4 ? index => sgr(open + 60 + index) :
 		colorDepth === 3 ?
 			open === fgOpen ?
@@ -27,11 +25,10 @@ function makeChannel(colorDepth, open, close) {
 				index => sgr(open + index) :
 		() => sgr(0);
 
-	/** @type {(code: number) => SGR} */
-	const x16ToX8 =
+	const x16ToX8: (code: number) => SGR =
 		open === fgOpen ?
 			code => code >= 60 ? style.bold.combine(sgr(open + code - 60)) : sgr(open + code) :
-			code => code >= 60 ? sgr(open + code - 60) : sgr(open + code);
+			code => code >= 60 ? sgr(open + code - 60)                     : sgr(open + code);
 
 	return {
 		black   : sgr(open + 0),
@@ -62,43 +59,37 @@ function makeChannel(colorDepth, open, close) {
 					(r, g, b) => sgr(open + rgbToX8(...clip(r, g, b))) :
 			() => sgr(0),
 
-		/** @type {(...args: [number] | [number, number, number]) => SGR} */
 		x256:
 			colorDepth >= 8 ?
-				(...args) => sgr(
+				(...args: [number] | [number, number, number]): SGR => sgr(
 					[open + 8, 5, args.length === 3 ? rgbToX256(...clip(...args)) : clip(args[0])],
 				) :
 			colorDepth >= 4 ?
-				(...args) => sgr(
+				(...args: [number] | [number, number, number]): SGR => sgr(
 					open +
 					rgbToX16(...(args.length === 3 ? clip(...args) : x256ToRgb(clip(args[0])))),
 				) :
 			colorDepth === 3 ?
 				open === fgOpen ?
-					(...args) => x16ToX8(
-						args.length === 3 ?
-							rgbToX16(...clip(...args)) :
-							rgbToX16(...x256ToRgb(clip(args[0]))),
+					(...args: [number] | [number, number, number]): SGR => x16ToX8(
+						args.length === 3
+							? rgbToX16(...clip(...args))
+							: rgbToX16(...x256ToRgb(clip(args[0]))),
 					) :
-					(...args) => sgr(
-						open + rgbToX8(
-						...args.length === 3 ? clip(...args) : x256ToRgb(clip(args[0])),
-						),
+					(...args: [number] | [number, number, number]): SGR => sgr(
+						open +
+						rgbToX8(...args.length === 3 ? clip(...args) : x256ToRgb(clip(args[0]))),
 					) :
-			() => sgr(0),
+			(): SGR => sgr(0),
 
 		default: colorDepth > 1 ? `\x1b[${close}m` : "",
 	};
 }
 
-/** @type {Partial<Record<ColorDepth, {fg: Channel, bg: Channel}>>} */
-const cache = {};
+const cache: Partial<Record<ColorDepth, Color>> = {};
 
-/** @type {(colorDepth: ColorDepth) => {fg: Channel, bg: Channel}} */
-const makeColor = (colorDepth = 4) =>
+export const makeColor = (colorDepth: ColorDepth = 4): Color =>
 	cache[colorDepth] ?? (cache[colorDepth] = {
 		fg : makeChannel(colorDepth, fgOpen, fgClose),
 		bg : makeChannel(colorDepth, bgOpen, bgClose),
-	});
-
-module.exports = {makeColor};
+	});

package/src/sgr/color/index.ts

@@ -0,0 +1 @@
+export * from "./color";

package/src/sgr/color/{types.d.ts → types.ts}

@@ -1,3 +1,5 @@
+import type {SGR} from "../sgr";
+
 export interface Channel {
 	black   : SGR;
 	red     : SGR;
@@ -24,5 +26,7 @@ export interface Channel {
 		(r: number, g: number, b: number): SGR;
 	};
 
-	default: string,
-}
+	default: string;
+}
+
+export type Color = {fg: Channel; bg: Channel};