@peteanderson/ansi 0.1.0 → 0.1.1

package/README.md

@@ -16,7 +16,8 @@ const ansi = require("@peteanderson/ansi");
 console.log(ansi.fg.red + "error: something went wrong" + ansi.fg.default);
 console.log(ansi.bg.blue + ansi.fg.white + "highlighted" + ansi.fg.default + ansi.bg.default);
 console.log(ansi.erase.screen);
-console.log(ansi.caret.show);
+console.log(ansi.slice(coloredText, 0, 10)); // slice by visible characters
+console.log(ansi.strip(coloredText)); // remove ANSI codes
 ```
 
 ## API
@@ -55,6 +56,11 @@ Raw sequences:
 
 Removes ANSI CSI sequences from a string.
 
+### `slice(text, start, end)`
+
+Slices a string by visible characters, ignoring ANSI sequences. Works like `String.prototype.slice`
+but counts only visible characters.
+
 ## License
 
 MIT

package/dist/ansi.d.ts

@@ -62,3 +62,5 @@ export namespace caret {
 }
 export let scrollUp: (lines: number) => string;
 export let scrollDown: (lines: number) => string;
+export let strip: (text: string) => string;
+export function slice(text: string, start: number, end: number): string;

package/dist/ansi.js

@@ -1,4 +1,5 @@
 "use strict";
+const rxCSI = /\x1b\[[0-?]*[ -/]*[@-~]/g;
 /** @type {(r: number, g: number, b: number, code: number) => string} */
 function rgb(r, g, b, code) {
     if (r === g && g === b) {
@@ -71,5 +72,49 @@ const ansi = {
     scrollUp: lines => `\x1b[${lines}S`,
     /** @type {(lines: number) => string} */
     scrollDown: lines => `\x1b[${lines}T`,
+    /** @type {(text: string) => string} */
+    strip: text => text.replace(rxCSI, ''),
+    /** @type {(text: string, start: number, end: number) => string} */
+    slice(text, start, end) {
+        if (start < 0 || end < 0) {
+            const visibleLength = ansi.strip(text).length;
+            if (start < 0)
+                start = Math.max(0, visibleLength + start);
+            if (end < 0)
+                end = Math.max(0, visibleLength + end);
+        }
+        if (start > end)
+            return "";
+        let visibleIndex = 0;
+        let startIndex = 0;
+        while (startIndex < text.length && visibleIndex < start) {
+            if (text[startIndex] === "\x1b") {
+                rxCSI.lastIndex = startIndex;
+                const match = rxCSI.exec(text);
+                if (match?.index === startIndex) {
+                    startIndex += match[0].length;
+                    continue;
+                }
+            }
+            startIndex++;
+            visibleIndex++;
+        }
+        let endIndex = startIndex;
+        let hasAnsi = false;
+        while (endIndex < text.length && visibleIndex < end) {
+            if (text[endIndex] === "\x1b") {
+                rxCSI.lastIndex = endIndex;
+                const match = rxCSI.exec(text);
+                if (match?.index === endIndex) {
+                    endIndex += match[0].length;
+                    hasAnsi = true;
+                    continue;
+                }
+            }
+            endIndex++;
+            visibleIndex++;
+        }
+        return text.slice(startIndex, endIndex) + (hasAnsi ? ansi.reset : "");
+    },
 };
 module.exports = ansi;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name"            : "@peteanderson/ansi",
-	"version"         : "0.1.0",
+	"version"         : "0.1.1",
 	"description"     : "ANSI escape sequence generation with automatic feature detection",
 	"author"          : {
 		"name"  : "Pete Anderson",

package/src/ansi.js

@@ -1,5 +1,7 @@
 "use strict";
 
+const rxCSI = /\x1b\[[0-?]*[ -/]*[@-~]/g;
+
 /** @type {(r: number, g: number, b: number, code: number) => string} */
 function rgb(r, g, b, code) {
 	if (r === g && g === b) {
@@ -84,6 +86,58 @@ const ansi = {
 	scrollUp   : lines => `\x1b[${lines}S`,
 	/** @type {(lines: number) => string} */
 	scrollDown : lines => `\x1b[${lines}T`,
+
+	/** @type {(text: string) => string} */
+	strip: text => text.replace(rxCSI, ''),
+
+	/** @type {(text: string, start: number, end: number) => string} */
+	slice(text, start, end) {
+		if (start < 0 || end < 0) {
+			const visibleLength = ansi.strip(text).length;
+			if (start < 0)
+				start = Math.max(0, visibleLength + start);
+			if (end < 0)
+				end = Math.max(0, visibleLength + end);
+		}
+		if (start > end)
+			return "";
+
+		let visibleIndex = 0;
+		let startIndex   = 0;
+
+		while (startIndex < text.length && visibleIndex < start) {
+			if (text[startIndex] === "\x1b") {
+				rxCSI.lastIndex = startIndex;
+				const match = rxCSI.exec(text);
+				if (match?.index === startIndex) {
+					startIndex += match[0].length;
+					continue;
+				}
+			}
+
+			startIndex++;
+			visibleIndex++;
+		}
+
+		let endIndex = startIndex;
+		let hasAnsi  = false;
+		while (endIndex < text.length && visibleIndex < end) {
+			if (text[endIndex] === "\x1b") {
+				rxCSI.lastIndex = endIndex;
+				const match = rxCSI.exec(text);
+				if (match?.index === endIndex) {
+					endIndex += match[0].length;
+					hasAnsi = true;
+					continue;
+				}
+			}
+
+			endIndex++;
+			visibleIndex++;
+		}
+
+		return text.slice(startIndex, endIndex) + (hasAnsi ? ansi.reset : "");
+	},
 };
 
 module.exports = ansi;