cli-truncate 3.0.0 → 4.0.0

package/index.d.ts

@@ -1,4 +1,4 @@
-export interface Options {
+export type Options = {
 	/**
 	The position to truncate the string.
 
@@ -50,12 +50,32 @@ export interface Options {
 	````
 	*/
 	readonly preferTruncationOnSpace?: boolean;
-}
+
+	/**
+	The character to use at the breaking point.
+
+	@default '…'
+
+	@example
+	```
+	import cliTruncate from 'cli-truncate';
+
+	cliTruncate('unicorns', 5, {position: 'end'});
+	//=> 'unic…'
+
+	cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: '.'});
+	//=> 'unic.'
+
+	cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: ''});
+	//=> 'unico'
+	*/
+	readonly truncationCharacter?: string;
+};
 
 /**
 Truncate a string to a specific width in the terminal.
 
-@param text - Text to truncate.
+@param text - The text to truncate.
 @param columns - The number of columns to occupy in the terminal.
 
 @example
@@ -85,7 +105,7 @@ cliTruncate('안녕하세요', 3);
 
 // Truncate the paragraph to the terminal width
 const paragraph = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.';
-cliTruncate(paragraph, process.stdout.columns));
+cliTruncate(paragraph, process.stdout.columns);
 //=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
 ```
 */

package/index.js

@@ -6,29 +6,26 @@ function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
 		return wantedIndex;
 	}
 
-	for (let index = 1; index <= 3; index++) {
-		if (shouldSearchRight) {
-			if (string.charAt(wantedIndex + index) === ' ') {
-				return wantedIndex + index;
-			}
-		} else if (string.charAt(wantedIndex - index) === ' ') {
-			return wantedIndex - index;
+	const direction = shouldSearchRight ? 1 : -1;
+
+	for (let index = 0; index <= 3; index++) {
+		const finalIndex = wantedIndex + (index * direction);
+		if (string.charAt(finalIndex) === ' ') {
+			return finalIndex;
 		}
 	}
 
 	return wantedIndex;
 }
 
-export default function cliTruncate(text, columns, options) {
-	options = {
-		position: 'end',
-		preferTruncationOnSpace: false,
-		...options,
-	};
+export default function cliTruncate(text, columns, options = {}) {
+	const {
+		position = 'end',
+		space = false,
+		preferTruncationOnSpace = false,
+	} = options;
 
-	const {position, space, preferTruncationOnSpace} = options;
-	let ellipsis = '…';
-	let ellipsisWidth = 1;
+	let {truncationCharacter = '…'} = options;
 
 	if (typeof text !== 'string') {
 		throw new TypeError(`Expected \`input\` to be a string, got ${typeof text}`);
@@ -43,7 +40,7 @@ export default function cliTruncate(text, columns, options) {
 	}
 
 	if (columns === 1) {
-		return ellipsis;
+		return truncationCharacter;
 	}
 
 	const length = stringWidth(text);
@@ -55,21 +52,19 @@ export default function cliTruncate(text, columns, options) {
 	if (position === 'start') {
 		if (preferTruncationOnSpace) {
 			const nearestSpace = getIndexOfNearestSpace(text, length - columns + 1, true);
-			return ellipsis + sliceAnsi(text, nearestSpace, length).trim();
+			return truncationCharacter + sliceAnsi(text, nearestSpace, length).trim();
 		}
 
 		if (space === true) {
-			ellipsis += ' ';
-			ellipsisWidth = 2;
+			truncationCharacter += ' ';
 		}
 
-		return ellipsis + sliceAnsi(text, length - columns + ellipsisWidth, length);
+		return truncationCharacter + sliceAnsi(text, length - columns + stringWidth(truncationCharacter), length);
 	}
 
 	if (position === 'middle') {
 		if (space === true) {
-			ellipsis = ` ${ellipsis} `;
-			ellipsisWidth = 3;
+			truncationCharacter = ` ${truncationCharacter} `;
 		}
 
 		const half = Math.floor(columns / 2);
@@ -77,28 +72,27 @@ export default function cliTruncate(text, columns, options) {
 		if (preferTruncationOnSpace) {
 			const spaceNearFirstBreakPoint = getIndexOfNearestSpace(text, half);
 			const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + 1, true);
-			return sliceAnsi(text, 0, spaceNearFirstBreakPoint) + ellipsis + sliceAnsi(text, spaceNearSecondBreakPoint, length).trim();
+			return sliceAnsi(text, 0, spaceNearFirstBreakPoint) + truncationCharacter + sliceAnsi(text, spaceNearSecondBreakPoint, length).trim();
 		}
 
 		return (
 			sliceAnsi(text, 0, half)
-				+ ellipsis
-				+ sliceAnsi(text, length - (columns - half) + ellipsisWidth, 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) + ellipsis;
+			return sliceAnsi(text, 0, nearestSpace) + truncationCharacter;
 		}
 
 		if (space === true) {
-			ellipsis = ` ${ellipsis}`;
-			ellipsisWidth = 2;
+			truncationCharacter = ` ${truncationCharacter}`;
 		}
 
-		return sliceAnsi(text, 0, columns - ellipsisWidth) + ellipsis;
+		return sliceAnsi(text, 0, columns - stringWidth(truncationCharacter)) + 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": "3.0.0",
+	"version": "4.0.0",
 	"description": "Truncate a string to a specific width in the terminal",
 	"license": "MIT",
 	"repository": "sindresorhus/cli-truncate",
@@ -11,9 +11,12 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
 	"engines": {
-		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+		"node": ">=18"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -38,11 +41,11 @@
 	],
 	"dependencies": {
 		"slice-ansi": "^5.0.0",
-		"string-width": "^5.0.0"
+		"string-width": "^7.0.0"
 	},
 	"devDependencies": {
-		"ava": "^3.15.0",
-		"tsd": "^0.17.0",
-		"xo": "^0.44.0"
+		"ava": "^5.3.1",
+		"tsd": "^0.29.0",
+		"xo": "^0.56.0"
 	}
 }

package/readme.md

@@ -6,8 +6,8 @@ Gracefully handles [ANSI escapes](https://en.wikipedia.org/wiki/ANSI_escape_code
 
 ## Install
 
-```
-$ npm install cli-truncate
+```sh
+npm install cli-truncate
 ```
 
 ## Usage
@@ -41,7 +41,7 @@ cliTruncate('안녕하세요', 3);
 
 // Truncate the paragraph to the terminal width
 const paragraph = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.';
-cliTruncate(paragraph, process.stdout.columns));
+cliTruncate(paragraph, process.stdout.columns);
 //=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
 ```
 
@@ -53,7 +53,7 @@ cliTruncate(paragraph, process.stdout.columns));
 
 Type: `string`
 
-Text to truncate.
+The text to truncate.
 
 #### columns
 
@@ -69,7 +69,7 @@ Type: `object`
 
 Type: `string`\
 Default: `'end'`\
-Values: `'start'` `'middle'` `'end'`
+Values: `'start' | 'middle' | 'end'`
 
 The position to truncate the string.
 
@@ -124,19 +124,27 @@ cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncation
 //=> 'uni…ns'
 ```
 
+##### truncationCharacter
+
+Type: `string`\
+Default: `…`
+
+The character to use at the breaking point.
+
+```js
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorns', 5, {position: 'end'});
+//=> 'unic…'
+
+cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: '.'});
+//=> 'unic.'
+
+cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: ''});
+//=> 'unico'
+```
+
 ## Related
 
 - [wrap-ansi](https://github.com/chalk/wrap-ansi) - Wordwrap a string with ANSI escape codes
 - [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
-
----
-
-<div align="center">
-	<b>
-		<a href="https://tidelift.com/subscription/pkg/npm-cli-truncate?utm_source=npm-cli-truncate&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
-	</b>
-	<br>
-	<sub>
-		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
-	</sub>
-</div>