cli-truncate 4.0.0 → 5.1.0

package/index.d.ts

@@ -93,7 +93,9 @@ cliTruncate('unicorn', 4, {position: 'middle'});
 //=> 'un…n'
 
 cliTruncate('\u001B[31municorn\u001B[39m', 4);
-//=> '\u001B[31muni\u001B[39m…'
+//=> '\u001B[31muni…\u001B[39m'
+
+// Note: When truncating styled text (ANSI escapes), the truncation character inherits the style at the breaking point for `position: 'start'` and `position: 'end'`. This does not apply to `position: 'middle'`.
 
 // Truncate Unicode surrogate pairs
 cliTruncate('uni\uD83C\uDE00corn', 5);

package/index.js

@@ -49,21 +49,88 @@ export default function cliTruncate(text, columns, options = {}) {
 		return text;
 	}
 
+	// ANSI escape sequence constants
+	const ANSI = {
+		ESC: 27,
+		LEFT_BRACKET: 91,
+		LETTER_M: 109,
+	};
+
+	const isSgrParameter = code => (code >= 48 && code <= 57) || code === 59; // 0-9 or ;
+
+	function leadingSgrSpanEndIndex(string) {
+		let index = 0;
+		while (index + 2 < string.length && string.codePointAt(index) === ANSI.ESC && string.codePointAt(index + 1) === ANSI.LEFT_BRACKET) {
+			let j = index + 2;
+			while (j < string.length && isSgrParameter(string.codePointAt(j))) {
+				j++;
+			}
+
+			if (j < string.length && string.codePointAt(j) === ANSI.LETTER_M) {
+				index = j + 1;
+				continue;
+			}
+
+			break;
+		}
+
+		return index;
+	}
+
+	function trailingSgrSpanStartIndex(string) {
+		let start = string.length;
+		while (start > 1 && string.codePointAt(start - 1) === ANSI.LETTER_M) {
+			let j = start - 2;
+			while (j >= 0 && isSgrParameter(string.codePointAt(j))) {
+				j--;
+			}
+
+			if (j >= 1 && string.codePointAt(j - 1) === ANSI.ESC && string.codePointAt(j) === ANSI.LEFT_BRACKET) {
+				start = j - 1;
+				continue;
+			}
+
+			break;
+		}
+
+		return start;
+	}
+
+	function appendWithInheritedStyleFromEnd(visible, suffix) {
+		const start = trailingSgrSpanStartIndex(visible);
+		if (start === visible.length) {
+			return visible + suffix;
+		}
+
+		return visible.slice(0, start) + suffix + visible.slice(start);
+	}
+
+	function prependWithInheritedStyleFromStart(prefix, visible) {
+		const end = leadingSgrSpanEndIndex(visible);
+		if (end === 0) {
+			return prefix + visible;
+		}
+
+		return visible.slice(0, end) + prefix + visible.slice(end);
+	}
+
 	if (position === 'start') {
 		if (preferTruncationOnSpace) {
 			const nearestSpace = getIndexOfNearestSpace(text, length - columns + 1, true);
-			return truncationCharacter + sliceAnsi(text, nearestSpace, length).trim();
+			const right = sliceAnsi(text, nearestSpace, length).trim();
+			return prependWithInheritedStyleFromStart(truncationCharacter, right);
 		}
 
-		if (space === true) {
+		if (space) {
 			truncationCharacter += ' ';
 		}
 
-		return truncationCharacter + sliceAnsi(text, length - columns + stringWidth(truncationCharacter), length);
+		const right = sliceAnsi(text, length - columns + stringWidth(truncationCharacter), length);
+		return prependWithInheritedStyleFromStart(truncationCharacter, right);
 	}
 
 	if (position === 'middle') {
-		if (space === true) {
+		if (space) {
 			truncationCharacter = ` ${truncationCharacter} `;
 		}
 
@@ -77,22 +144,24 @@ export default function cliTruncate(text, columns, options = {}) {
 
 		return (
 			sliceAnsi(text, 0, half)
-				+ truncationCharacter
-				+ sliceAnsi(text, length - (columns - half) + stringWidth(truncationCharacter), length)
+			+ truncationCharacter
+			+ sliceAnsi(text, length - (columns - half) + stringWidth(truncationCharacter), length)
 		);
 	}
 
 	if (position === 'end') {
 		if (preferTruncationOnSpace) {
 			const nearestSpace = getIndexOfNearestSpace(text, columns - 1);
-			return sliceAnsi(text, 0, nearestSpace) + truncationCharacter;
+			const left = sliceAnsi(text, 0, nearestSpace);
+			return appendWithInheritedStyleFromEnd(left, truncationCharacter);
 		}
 
-		if (space === true) {
+		if (space) {
 			truncationCharacter = ` ${truncationCharacter}`;
 		}
 
-		return sliceAnsi(text, 0, columns - stringWidth(truncationCharacter)) + truncationCharacter;
+		const left = sliceAnsi(text, 0, columns - stringWidth(truncationCharacter));
+		return appendWithInheritedStyleFromEnd(left, truncationCharacter);
 	}
 
 	throw new Error(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "cli-truncate",
-	"version": "4.0.0",
+	"version": "5.1.0",
 	"description": "Truncate a string to a specific width in the terminal",
 	"license": "MIT",
 	"repository": "sindresorhus/cli-truncate",
@@ -15,8 +15,9 @@
 		"types": "./index.d.ts",
 		"default": "./index.js"
 	},
+	"sideEffects": false,
 	"engines": {
-		"node": ">=18"
+		"node": ">=20"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -40,12 +41,12 @@
 		"string"
 	],
 	"dependencies": {
-		"slice-ansi": "^5.0.0",
-		"string-width": "^7.0.0"
+		"slice-ansi": "^7.1.0",
+		"string-width": "^8.0.0"
 	},
 	"devDependencies": {
-		"ava": "^5.3.1",
-		"tsd": "^0.29.0",
-		"xo": "^0.56.0"
+		"ava": "^6.4.1",
+		"tsd": "^0.33.0",
+		"xo": "^1.2.2"
 	}
 }

package/readme.md

@@ -25,11 +25,14 @@ cliTruncate('unicorn', 4, {position: 'start'});
 cliTruncate('unicorn', 4, {position: 'middle'});
 //=> 'un…n'
 
-cliTruncate('unicorns rainbow dragons', 6, {position: 'end'})
+cliTruncate('unicorns rainbow dragons', 6, {position: 'end'});
 //=> 'unico…'
 
 cliTruncate('\u001B[31municorn\u001B[39m', 4);
-//=> '\u001B[31muni\u001B[39m…'
+//=> '\u001B[31muni…\u001B[39m'
+
+> [!NOTE]
+> When truncating styled text (ANSI escapes), the truncation character inherits the style at the breaking point for `position: 'start'` and `position: 'end'`. This does not apply to `position: 'middle'`.
 
 // Truncate Unicode surrogate pairs
 cliTruncate('uni\uD83C\uDE00corn', 5);
@@ -106,21 +109,21 @@ Truncate the string from a whitespace if it is within 3 characters from the actu
 ```js
 import cliTruncate from 'cli-truncate';
 
-cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true})
+cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true});
 //=> '…rainbow dragons'
 
-// without preferTruncationOnSpace
-cliTruncate('unicorns rainbow dragons', 20, {position: 'start'})
+// Without preferTruncationOnSpace
+cliTruncate('unicorns rainbow dragons', 20, {position: 'start'});
 //=> '…rns rainbow dragons'
 
-cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true})
+cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true});
 //=> 'unicorns…dragons'
 
-cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true})
+cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true});
 //=> 'unico…'
 
-// preferTruncationOnSpace would have no effect if space isn't found within next 3 indexes
-cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncationOnSpace: true})
+// preferTruncationOnSpace has no effect if space isn't found within 3 characters
+cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncationOnSpace: true});
 //=> 'uni…ns'
 ```
 
@@ -142,6 +145,7 @@ cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: '.'});
 
 cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: ''});
 //=> 'unico'
+
 ```
 
 ## Related