@peteanderson/ansi 3.1.0 → 3.3.0

package/dist/cjs/slice.d.ts

@@ -2,6 +2,7 @@ export declare function scanCSI(text: string, fromStringIndex: number, visibleCo
     index: number;
     length: number;
 };
+export declare function skippedSequences(text: string, start: number, end?: number): string;
 /**
  * Return a slice of the given text, counting only visible characters (i.e. ignoring ANSI escape
  * codes). The returned slice will include any ANSI escape codes from within the slice. In addition,
@@ -10,6 +11,14 @@ export declare function scanCSI(text: string, fromStringIndex: number, visibleCo
  * printed. If you compose two or more slices together, there may be redundant SGR sequences at the
  * boundaries, but the result will be correct. You can use `simplify` to remove the redundancies.
  *
+ * Negative indices for `start` or `end` are interpreted as offsets from the end of the string,
+ * counting only visible characters. For example, `slice(text, -1)` returns a string containing only
+ * the last visible character of `text`, as well as any SGR codes from before and after that
+ * character.
+ *
+ * This function is analogous to `String.prototype.slice`. If the given string contains no ANSI
+ * sequences, the result will be the same as `text.slice(start, end)`.
+ *
  * Note the following caveats:
  *
  *   * Any non-SGR ANSI codes prior to or after the slice will be ignored.
@@ -21,6 +30,6 @@ export declare function scanCSI(text: string, fromStringIndex: number, visibleCo
  * of the slice as it would be if the whole string were printed. This function is intended mostly
  * for text that contains SGR codes, but no other ANSI codes or control characters.
  */
-export declare function slice(text: string, start: number, end: number): string;
+export declare function slice(text: string, start: number, end?: number): string;
 export type Slice = typeof slice;
 //# sourceMappingURL=slice.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":"AAIA,wBAAgB,OAAO,CACtB,IAAI,EAAc,MAAM,EACxB,eAAe,EAAG,MAAM,EACxB,YAAY,EAAM,MAAM,GACtB;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAsBjC;AAOD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CA6BtE;AAED,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC"}
+{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":"AAIA,wBAAgB,OAAO,CACtB,IAAI,EAAc,MAAM,EACxB,eAAe,EAAG,MAAM,EACxB,YAAY,EAAM,MAAM,GACtB;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAsBjC;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAGlF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CA8BvE;AAED,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC"}

package/dist/cjs/slice.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.scanCSI = scanCSI;
+exports.skippedSequences = skippedSequences;
 exports.slice = slice;
 const patterns_1 = require("./patterns");
 const simplify_1 = require("./simplify");
@@ -36,6 +37,14 @@ function skippedSequences(text, start, end) {
  * printed. If you compose two or more slices together, there may be redundant SGR sequences at the
  * boundaries, but the result will be correct. You can use `simplify` to remove the redundancies.
  *
+ * Negative indices for `start` or `end` are interpreted as offsets from the end of the string,
+ * counting only visible characters. For example, `slice(text, -1)` returns a string containing only
+ * the last visible character of `text`, as well as any SGR codes from before and after that
+ * character.
+ *
+ * This function is analogous to `String.prototype.slice`. If the given string contains no ANSI
+ * sequences, the result will be the same as `text.slice(start, end)`.
+ *
  * Note the following caveats:
  *
  *   * Any non-SGR ANSI codes prior to or after the slice will be ignored.
@@ -50,13 +59,12 @@ function skippedSequences(text, start, end) {
 function slice(text, start, end) {
     let textVisibleLength;
     const getVisibleLength = () => textVisibleLength ??= (0, strip_1.visibleLength)(text);
-    if (start < 0 || end < 0) {
-        textVisibleLength = getVisibleLength();
-        if (start < 0)
-            start = Math.max(0, textVisibleLength + start);
-        if (end < 0)
-            end = Math.max(0, textVisibleLength + end);
-    }
+    if (end === undefined)
+        end = getVisibleLength();
+    if (start < 0)
+        start = Math.max(0, getVisibleLength() + start);
+    if (end < 0)
+        end = Math.max(0, getVisibleLength() + end);
     if (start > end)
         return "";
     if (start === 0 && (end >= text.length || end >= getVisibleLength()))

package/dist/cjs/slice.js.map

@@ -1 +1 @@
-{"version":3,"file":"slice.js","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":";;AAIA,0BA0BC;AA0BD,sBA6BC;AArFD,yCAAyC;AACzC,yCAAyC;AACzC,mCAAsC;AAEtC,SAAgB,OAAO,CACtB,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,KAAK,IAAA,qBAAa,EAAC,IAAI,CAAC,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"}
+{"version":3,"file":"slice.js","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":";;AAIA,0BA0BC;AAED,4CAGC;AA6BD,sBA8BC;AA9FD,yCAAyC;AACzC,yCAAyC;AACzC,mCAAsC;AAEtC,SAAgB,OAAO,CACtB,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,SAAgB,gBAAgB,CAAC,IAAY,EAAE,KAAa,EAAE,GAAY;IACzE,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;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,KAAK,CAAC,IAAY,EAAE,KAAa,EAAE,GAAY;IAC9D,IAAI,iBAAqC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,iBAAiB,KAAK,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;IAEzE,IAAI,GAAG,KAAK,SAAS;QACpB,GAAG,GAAG,gBAAgB,EAAE,CAAC;IAE1B,IAAI,KAAK,GAAG,CAAC;QACZ,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC,CAAC;IACjD,IAAI,GAAG,GAAG,CAAC;QACV,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,GAAG,CAAC,CAAC;IAE7C,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/cjs/split-at.d.ts

@@ -3,10 +3,10 @@
  * 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.
+ * Note that unlike {@linkcode slice}, this function doesn't, by default 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, pass `true` for the `includeSkipped` parameter.
  */
-export declare function splitAt(text: string, visibleIndex: number): [start: string, end: string];
+export declare function splitAt(text: string, visibleIndex: number, includeSkipped?: boolean): [start: string, end: string];
 export type SplitAt = typeof splitAt;
 //# sourceMappingURL=split-at.d.ts.map

package/dist/cjs/split-at.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"split-at.d.ts","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAgBxF;AAED,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC"}
+{"version":3,"file":"split-at.d.ts","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":"AAKA;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CACtB,IAAI,EAAa,MAAM,EACvB,YAAY,EAAK,MAAM,EACvB,cAAc,GAAG,OAAe,GAC9B,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAwB9B;AAED,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC"}

package/dist/cjs/split-at.js

@@ -2,25 +2,32 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.splitAt = splitAt;
 const slice_1 = require("./slice");
+const strip_1 = require("./strip");
 /**
  * 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.
+ * Note that unlike {@linkcode slice}, this function doesn't, by default 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, pass `true` for the `includeSkipped` parameter.
  */
-function splitAt(text, visibleIndex) {
+function splitAt(text, visibleIndex, includeSkipped = false) {
     if (!visibleIndex)
         return ["", text];
     if (visibleIndex < 0)
-        throw new Error("visibleIndex must be non-negative");
+        visibleIndex = Math.max(0, (0, strip_1.visibleLength)(text) + visibleIndex);
     if (visibleIndex > text.length)
         return [text, ""];
     const { index } = (0, slice_1.scanCSI)(text, 0, visibleIndex);
     if (index === text.length)
         return [text, ""];
-    return [text.slice(0, index), text.slice(index)];
+    let start = text.slice(0, index);
+    let end = text.slice(index);
+    if (includeSkipped) {
+        start += (0, slice_1.skippedSequences)(text, index);
+        end = (0, slice_1.skippedSequences)(text, 0, index) + end;
+    }
+    return [start, end];
 }
 //# sourceMappingURL=split-at.js.map

package/dist/cjs/split-at.js.map

@@ -1 +1 @@
-{"version":3,"file":"split-at.js","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":";;AAaA,0BAgBC;AA7BD,mCAAgC;AAIhC;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAC,IAAY,EAAE,YAAoB;IACzD,IAAI,CAAC,YAAY;QAChB,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAEnB,IAAI,YAAY,GAAG,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEtD,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM;QAC7B,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,MAAM,EAAC,KAAK,EAAC,GAAG,IAAA,eAAO,EAAC,IAAI,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IAE/C,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;QACxB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAClD,CAAC"}
+{"version":3,"file":"split-at.js","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":";;AAcA,0BA4BC;AA1CD,mCAAkD;AAClD,mCAAkD;AAIlD;;;;;;;;GAQG;AACH,SAAgB,OAAO,CACtB,IAAuB,EACvB,YAAuB,EACvB,iBAA2B,KAAK;IAEhC,IAAI,CAAC,YAAY;QAChB,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAEnB,IAAI,YAAY,GAAG,CAAC;QACnB,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAA,qBAAa,EAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC;IAEhE,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM;QAC7B,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,MAAM,EAAC,KAAK,EAAC,GAAG,IAAA,eAAO,EAAC,IAAI,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IAE/C,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;QACxB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACjC,IAAI,GAAG,GAAK,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE9B,IAAI,cAAc,EAAE,CAAC;QACpB,KAAK,IAAI,IAAA,wBAAgB,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACvC,GAAG,GAAM,IAAA,wBAAgB,EAAC,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC;IACjD,CAAC;IAED,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACrB,CAAC"}

package/dist/esm/slice.d.ts

@@ -2,6 +2,7 @@ export declare function scanCSI(text: string, fromStringIndex: number, visibleCo
     index: number;
     length: number;
 };
+export declare function skippedSequences(text: string, start: number, end?: number): string;
 /**
  * Return a slice of the given text, counting only visible characters (i.e. ignoring ANSI escape
  * codes). The returned slice will include any ANSI escape codes from within the slice. In addition,
@@ -10,6 +11,14 @@ export declare function scanCSI(text: string, fromStringIndex: number, visibleCo
  * printed. If you compose two or more slices together, there may be redundant SGR sequences at the
  * boundaries, but the result will be correct. You can use `simplify` to remove the redundancies.
  *
+ * Negative indices for `start` or `end` are interpreted as offsets from the end of the string,
+ * counting only visible characters. For example, `slice(text, -1)` returns a string containing only
+ * the last visible character of `text`, as well as any SGR codes from before and after that
+ * character.
+ *
+ * This function is analogous to `String.prototype.slice`. If the given string contains no ANSI
+ * sequences, the result will be the same as `text.slice(start, end)`.
+ *
  * Note the following caveats:
  *
  *   * Any non-SGR ANSI codes prior to or after the slice will be ignored.
@@ -21,6 +30,6 @@ export declare function scanCSI(text: string, fromStringIndex: number, visibleCo
  * of the slice as it would be if the whole string were printed. This function is intended mostly
  * for text that contains SGR codes, but no other ANSI codes or control characters.
  */
-export declare function slice(text: string, start: number, end: number): string;
+export declare function slice(text: string, start: number, end?: number): string;
 export type Slice = typeof slice;
 //# sourceMappingURL=slice.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":"AAIA,wBAAgB,OAAO,CACtB,IAAI,EAAc,MAAM,EACxB,eAAe,EAAG,MAAM,EACxB,YAAY,EAAM,MAAM,GACtB;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAsBjC;AAOD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CA6BtE;AAED,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC"}
+{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":"AAIA,wBAAgB,OAAO,CACtB,IAAI,EAAc,MAAM,EACxB,eAAe,EAAG,MAAM,EACxB,YAAY,EAAM,MAAM,GACtB;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAsBjC;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAGlF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CA8BvE;AAED,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC"}

package/dist/esm/slice.js

@@ -20,7 +20,7 @@ export function scanCSI(text, fromStringIndex, visibleCount) {
     }
     return { index, length };
 }
-function skippedSequences(text, start, end) {
+export function skippedSequences(text, start, end) {
     const sequences = text.slice(start, end).match(new RegExp(rxSGR));
     return sequences ? simplify(sequences.join("")) : "";
 }
@@ -32,6 +32,14 @@ function skippedSequences(text, start, end) {
  * printed. If you compose two or more slices together, there may be redundant SGR sequences at the
  * boundaries, but the result will be correct. You can use `simplify` to remove the redundancies.
  *
+ * Negative indices for `start` or `end` are interpreted as offsets from the end of the string,
+ * counting only visible characters. For example, `slice(text, -1)` returns a string containing only
+ * the last visible character of `text`, as well as any SGR codes from before and after that
+ * character.
+ *
+ * This function is analogous to `String.prototype.slice`. If the given string contains no ANSI
+ * sequences, the result will be the same as `text.slice(start, end)`.
+ *
  * Note the following caveats:
  *
  *   * Any non-SGR ANSI codes prior to or after the slice will be ignored.
@@ -46,13 +54,12 @@ function skippedSequences(text, start, end) {
 export function slice(text, start, end) {
     let textVisibleLength;
     const getVisibleLength = () => textVisibleLength ??= visibleLength(text);
-    if (start < 0 || end < 0) {
-        textVisibleLength = getVisibleLength();
-        if (start < 0)
-            start = Math.max(0, textVisibleLength + start);
-        if (end < 0)
-            end = Math.max(0, textVisibleLength + end);
-    }
+    if (end === undefined)
+        end = getVisibleLength();
+    if (start < 0)
+        start = Math.max(0, getVisibleLength() + start);
+    if (end < 0)
+        end = Math.max(0, getVisibleLength() + end);
     if (start > end)
         return "";
     if (start === 0 && (end >= text.length || end >= getVisibleLength()))

package/dist/esm/slice.js.map

@@ -1 +1 @@
-{"version":3,"file":"slice.js","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,KAAK,EAAC,MAAO,YAAY,CAAC;AACzC,OAAO,EAAC,QAAQ,EAAC,MAAW,YAAY,CAAC;AACzC,OAAO,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAEtC,MAAM,UAAU,OAAO,CACtB,IAAwB,EACxB,eAAwB,EACxB,YAAwB;IAExB,gEAAgE;IAChE,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,KAAK,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,KAAK,CAAC,CAAC,CAAC;IAClE,OAAO,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,KAAa,EAAE,GAAW;IAC7D,IAAI,iBAAqC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,iBAAiB,KAAK,aAAa,CAAC,IAAI,CAAC,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"}
+{"version":3,"file":"slice.js","sourceRoot":"","sources":["../../src/slice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,KAAK,EAAC,MAAO,YAAY,CAAC;AACzC,OAAO,EAAC,QAAQ,EAAC,MAAW,YAAY,CAAC;AACzC,OAAO,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAEtC,MAAM,UAAU,OAAO,CACtB,IAAwB,EACxB,eAAwB,EACxB,YAAwB;IAExB,gEAAgE;IAChE,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,KAAK,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,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,KAAa,EAAE,GAAY;IACzE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,OAAO,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,KAAa,EAAE,GAAY;IAC9D,IAAI,iBAAqC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,iBAAiB,KAAK,aAAa,CAAC,IAAI,CAAC,CAAC;IAEzE,IAAI,GAAG,KAAK,SAAS;QACpB,GAAG,GAAG,gBAAgB,EAAE,CAAC;IAE1B,IAAI,KAAK,GAAG,CAAC;QACZ,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC,CAAC;IACjD,IAAI,GAAG,GAAG,CAAC;QACV,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,GAAG,CAAC,CAAC;IAE7C,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/esm/split-at.d.ts

@@ -3,10 +3,10 @@
  * 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.
+ * Note that unlike {@linkcode slice}, this function doesn't, by default 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, pass `true` for the `includeSkipped` parameter.
  */
-export declare function splitAt(text: string, visibleIndex: number): [start: string, end: string];
+export declare function splitAt(text: string, visibleIndex: number, includeSkipped?: boolean): [start: string, end: string];
 export type SplitAt = typeof splitAt;
 //# sourceMappingURL=split-at.d.ts.map

package/dist/esm/split-at.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"split-at.d.ts","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAgBxF;AAED,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC"}
+{"version":3,"file":"split-at.d.ts","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":"AAKA;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CACtB,IAAI,EAAa,MAAM,EACvB,YAAY,EAAK,MAAM,EACvB,cAAc,GAAG,OAAe,GAC9B,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAwB9B;AAED,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC"}

package/dist/esm/split-at.js

@@ -1,23 +1,30 @@
-import { scanCSI } from "./slice.js";
+import { scanCSI, skippedSequences } from "./slice.js";
+import { visibleLength } from "./strip.js";
 /**
  * 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.
+ * Note that unlike {@linkcode slice}, this function doesn't, by default 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, pass `true` for the `includeSkipped` parameter.
  */
-export function splitAt(text, visibleIndex) {
+export function splitAt(text, visibleIndex, includeSkipped = false) {
     if (!visibleIndex)
         return ["", text];
     if (visibleIndex < 0)
-        throw new Error("visibleIndex must be non-negative");
+        visibleIndex = Math.max(0, visibleLength(text) + visibleIndex);
     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)];
+    let start = text.slice(0, index);
+    let end = text.slice(index);
+    if (includeSkipped) {
+        start += skippedSequences(text, index);
+        end = skippedSequences(text, 0, index) + end;
+    }
+    return [start, end];
 }
 //# sourceMappingURL=split-at.js.map

package/dist/esm/split-at.js.map

@@ -1 +1 @@
-{"version":3,"file":"split-at.js","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAIhC;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,IAAY,EAAE,YAAoB;IACzD,IAAI,CAAC,YAAY;QAChB,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAEnB,IAAI,YAAY,GAAG,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEtD,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM;QAC7B,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,MAAM,EAAC,KAAK,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IAE/C,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;QACxB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAClD,CAAC"}
+{"version":3,"file":"split-at.js","sourceRoot":"","sources":["../../src/split-at.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAClD,OAAO,EAAC,aAAa,EAAC,MAAkB,SAAS,CAAC;AAIlD;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CACtB,IAAuB,EACvB,YAAuB,EACvB,iBAA2B,KAAK;IAEhC,IAAI,CAAC,YAAY;QAChB,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAEnB,IAAI,YAAY,GAAG,CAAC;QACnB,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC;IAEhE,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM;QAC7B,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,MAAM,EAAC,KAAK,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IAE/C,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;QACxB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACjC,IAAI,GAAG,GAAK,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE9B,IAAI,cAAc,EAAE,CAAC;QACpB,KAAK,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACvC,GAAG,GAAM,gBAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC;IACjD,CAAC;IAED,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACrB,CAAC"}

package/package.json

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

package/src/slice.ts

@@ -30,7 +30,7 @@ export function scanCSI(
 	return {index, length};
 }
 
-function skippedSequences(text: string, start: number, end?: number): string {
+export function skippedSequences(text: string, start: number, end?: number): string {
 	const sequences = text.slice(start, end).match(new RegExp(rxSGR));
 	return sequences ? simplify(sequences.join("")) : "";
 }
@@ -43,6 +43,14 @@ function skippedSequences(text: string, start: number, end?: number): string {
  * printed. If you compose two or more slices together, there may be redundant SGR sequences at the
  * boundaries, but the result will be correct. You can use `simplify` to remove the redundancies.
  *
+ * Negative indices for `start` or `end` are interpreted as offsets from the end of the string,
+ * counting only visible characters. For example, `slice(text, -1)` returns a string containing only
+ * the last visible character of `text`, as well as any SGR codes from before and after that
+ * character.
+ *
+ * This function is analogous to `String.prototype.slice`. If the given string contains no ANSI
+ * sequences, the result will be the same as `text.slice(start, end)`.
+ *
  * Note the following caveats:
  *
  *   * Any non-SGR ANSI codes prior to or after the slice will be ignored.
@@ -54,17 +62,18 @@ function skippedSequences(text: string, start: number, end?: number): string {
  * of the slice as it would be if the whole string were printed. This function is intended mostly
  * for text that contains SGR codes, but no other ANSI codes or control characters.
  */
-export function slice(text: string, start: number, end: number): string {
+export function slice(text: string, start: number, end?: number): string {
 	let textVisibleLength: number | undefined;
 	const getVisibleLength = () => textVisibleLength ??= visibleLength(text);
 
-	if (start < 0 || end < 0) {
-		textVisibleLength = getVisibleLength();
-		if (start < 0)
-			start = Math.max(0, textVisibleLength + start);
-		if (end < 0)
-			end = Math.max(0, textVisibleLength + end);
-	}
+	if (end === undefined)
+		end = getVisibleLength();
+
+	if (start < 0)
+		start = Math.max(0, getVisibleLength() + start);
+	if (end < 0)
+		end = Math.max(0, getVisibleLength() + end);
+
 	if (start > end)
 		return "";
 

package/src/split-at.ts

@@ -1,4 +1,5 @@
-import {scanCSI} from "./slice";
+import {scanCSI, skippedSequences} from "./slice";
+import {visibleLength}             from "./strip";
 
 import type {slice} from "./slice";
 
@@ -7,16 +8,20 @@ import type {slice} from "./slice";
  * 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.
+ * Note that unlike {@linkcode slice}, this function doesn't, by default 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, pass `true` for the `includeSkipped` parameter.
  */
-export function splitAt(text: string, visibleIndex: number): [start: string, end: string] {
+export function splitAt(
+	text           : string,
+	visibleIndex   : number,
+	includeSkipped : boolean = false,
+): [start: string, end: string] {
 	if (!visibleIndex)
 		return ["", text];
 
 	if (visibleIndex < 0)
-		throw new Error("visibleIndex must be non-negative");
+		visibleIndex = Math.max(0, visibleLength(text) + visibleIndex);
 
 	if (visibleIndex > text.length)
 		return [text, ""];
@@ -26,7 +31,15 @@ export function splitAt(text: string, visibleIndex: number): [start: string, end
 	if (index === text.length)
 		return [text, ""];
 
-	return [text.slice(0, index), text.slice(index)];
+	let start = text.slice(0, index);
+	let end   = text.slice(index);
+
+	if (includeSkipped) {
+		start += skippedSequences(text, index);
+		end    = skippedSequences(text, 0, index) + end;
+	}
+
+	return [start, end];
 }
 
 export type SplitAt = typeof splitAt;