cli-truncate 1.1.0 → 3.1.0

package/index.d.ts

@@ -0,0 +1,116 @@
+export interface Options {
+	/**
+	The position to truncate the string.
+
+	@default 'end'
+	*/
+	readonly position?: 'start' | 'middle' | 'end';
+
+	/**
+	Add a space between the text and the ellipsis.
+
+	@default false
+
+	@example
+	```
+	import cliTruncate from 'cli-truncate';
+
+	cliTruncate('unicorns', 5, {position: 'end', space: true});
+	//=> 'uni …'
+
+	cliTruncate('unicorns', 5, {position: 'end', space: false});
+	//=> 'unic…'
+
+	cliTruncate('unicorns', 6, {position: 'start', space: true});
+	//=> '… orns'
+
+	cliTruncate('unicorns', 7, {position: 'middle', space: true});
+	//=> 'uni … s'
+	```
+	*/
+	readonly space?: boolean;
+
+	/**
+	Truncate the string from a whitespace if it is within 3 characters from the actual breaking point.
+
+	@default false
+
+	@example
+	```
+	import cliTruncate from 'cli-truncate';
+
+	cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true});
+	//=> '…rainbow dragons'
+
+	cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true});
+	//=> 'unicorns…dragons'
+
+	cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true});
+	//=> 'unico…'
+	````
+	*/
+	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 columns - The number of columns to occupy in the terminal.
+
+@example
+```
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorn', 4);
+//=> 'uni…'
+
+// Truncate at different positions
+cliTruncate('unicorn', 4, {position: 'start'});
+//=> '…orn'
+
+cliTruncate('unicorn', 4, {position: 'middle'});
+//=> 'un…n'
+
+cliTruncate('\u001B[31municorn\u001B[39m', 4);
+//=> '\u001B[31muni\u001B[39m…'
+
+// Truncate Unicode surrogate pairs
+cliTruncate('uni\uD83C\uDE00corn', 5);
+//=> 'uni\uD83C\uDE00…'
+
+// Truncate fullwidth characters
+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));
+//=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
+```
+*/
+export default function cliTruncate(
+	text: string,
+	columns: number,
+	options?: Options
+): string;

package/index.js

@@ -1,17 +1,37 @@
-'use strict';
-const sliceAnsi = require('slice-ansi');
-const stringWidth = require('string-width');
+import sliceAnsi from 'slice-ansi';
+import stringWidth from 'string-width';
 
-module.exports = (input, columns, opts) => {
-	opts = Object.assign({
-		position: 'end'
-	}, opts);
+function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
+	if (string.charAt(wantedIndex) === ' ') {
+		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;
+		}
+	}
+
+	return wantedIndex;
+}
 
-	const position = opts.position;
-	const ellipsis = '…';
+export default function cliTruncate(text, columns, options) {
+	options = {
+		position: 'end',
+		preferTruncationOnSpace: false,
+		truncationCharacter: '…',
+		...options,
+	};
 
-	if (typeof input !== 'string') {
-		throw new TypeError(`Expected \`input\` to be a string, got ${typeof input}`);
+	const {position, space, preferTruncationOnSpace} = options;
+	let {truncationCharacter} = options;
+
+	if (typeof text !== 'string') {
+		throw new TypeError(`Expected \`input\` to be a string, got ${typeof text}`);
 	}
 
 	if (typeof columns !== 'number') {
@@ -23,23 +43,60 @@ module.exports = (input, columns, opts) => {
 	}
 
 	if (columns === 1) {
-		return ellipsis;
+		return truncationCharacter;
 	}
 
-	const length = stringWidth(input);
+	const length = stringWidth(text);
 
 	if (length <= columns) {
-		return input;
+		return text;
 	}
 
 	if (position === 'start') {
-		return ellipsis + sliceAnsi(input, length - columns + 1, length);
-	} else if (position === 'middle') {
+		if (preferTruncationOnSpace) {
+			const nearestSpace = getIndexOfNearestSpace(text, length - columns + 1, true);
+			return truncationCharacter + sliceAnsi(text, nearestSpace, length).trim();
+		}
+
+		if (space === true) {
+			truncationCharacter += ' ';
+		}
+
+		return truncationCharacter + sliceAnsi(text, length - columns + stringWidth(truncationCharacter), length);
+	}
+
+	if (position === 'middle') {
+		if (space === true) {
+			truncationCharacter = ` ${truncationCharacter} `;
+		}
+
 		const half = Math.floor(columns / 2);
-		return sliceAnsi(input, 0, half) + ellipsis + sliceAnsi(input, length - (columns - half) + 1, length);
-	} else if (position === 'end') {
-		return sliceAnsi(input, 0, columns - 1) + ellipsis;
+
+		if (preferTruncationOnSpace) {
+			const spaceNearFirstBreakPoint = getIndexOfNearestSpace(text, half);
+			const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + 1, true);
+			return sliceAnsi(text, 0, spaceNearFirstBreakPoint) + truncationCharacter + sliceAnsi(text, spaceNearSecondBreakPoint, length).trim();
+		}
+
+		return (
+			sliceAnsi(text, 0, half)
+				+ 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;
+		}
+
+		if (space === true) {
+			truncationCharacter = ` ${truncationCharacter}`;
+		}
+
+		return sliceAnsi(text, 0, columns - stringWidth(truncationCharacter)) + truncationCharacter;
 	}
 
 	throw new Error(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);
-};
+}

package/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,22 +1,26 @@
 {
 	"name": "cli-truncate",
-	"version": "1.1.0",
+	"version": "3.1.0",
 	"description": "Truncate a string to a specific width in the terminal",
 	"license": "MIT",
 	"repository": "sindresorhus/cli-truncate",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=4"
+		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"truncate",
@@ -29,14 +33,16 @@
 		"term",
 		"shell",
 		"width",
-		"ansi"
+		"ansi",
+		"string"
 	],
 	"dependencies": {
-		"slice-ansi": "^1.0.0",
-		"string-width": "^2.0.0"
+		"slice-ansi": "^5.0.0",
+		"string-width": "^5.0.0"
 	},
 	"devDependencies": {
-		"ava": "*",
-		"xo": "*"
+		"ava": "^3.15.0",
+		"tsd": "^0.17.0",
+		"xo": "^0.44.0"
 	}
 }

package/readme.md

@@ -1,21 +1,19 @@
-# cli-truncate [![Build Status](https://travis-ci.org/sindresorhus/cli-truncate.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-truncate)
+# cli-truncate
 
 > Truncate a string to a specific width in the terminal
 
 Gracefully handles [ANSI escapes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles). Like a string styled with [`chalk`](https://github.com/chalk/chalk). It also supports Unicode surrogate pairs and fullwidth characters.
 
-
 ## Install
 
 ```
 $ npm install cli-truncate
 ```
 
-
 ## Usage
 
 ```js
-const cliTruncate = require('cli-truncate');
+import cliTruncate from 'cli-truncate';
 
 cliTruncate('unicorn', 4);
 //=> 'uni…'
@@ -27,6 +25,9 @@ cliTruncate('unicorn', 4, {position: 'start'});
 cliTruncate('unicorn', 4, {position: 'middle'});
 //=> 'un…n'
 
+cliTruncate('unicorns rainbow dragons', 6, {position: 'end'})
+//=> 'unico…'
+
 cliTruncate('\u001B[31municorn\u001B[39m', 4);
 //=> '\u001B[31muni\u001B[39m…'
 
@@ -44,12 +45,11 @@ cliTruncate(paragraph, process.stdout.columns));
 //=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
 ```
 
-
 ## API
 
-### cliTruncate(input, columns, [options])
+### cliTruncate(text, columns, options?)
 
-#### input
+#### text
 
 Type: `string`
 
@@ -59,27 +59,104 @@ Text to truncate.
 
 Type: `number`
 
-Columns to occupy in the terminal.
+The number of columns to occupy in the terminal.
 
 #### options
 
-Type: `Object`
+Type: `object`
 
 ##### position
 
-Type: `string`<br>
-Default: `end`<br>
-Values: `start` `middle` `end`
+Type: `string`\
+Default: `'end'`\
+Values: `'start'` `'middle'` `'end'`
+
+The position to truncate the string.
+
+##### space
+
+Type: `boolean`\
+Default: `false`
+
+Add a space between the text and the ellipsis.
+
+```js
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorns', 5, {space: false});
+//=> 'unic…'
+
+cliTruncate('unicorns', 5, {space: true});
+//=> 'uni …'
 
-Position to truncate the string.
+cliTruncate('unicorns', 6, {position: 'start', space: true});
+//=> '… orns'
+
+cliTruncate('unicorns', 7, {position: 'middle', space: true});
+//=> 'uni … s'
+```
 
+##### preferTruncationOnSpace
+
+Type: `boolean`\
+Default: `false`
+
+Truncate the string from a whitespace if it is within 3 characters from the actual breaking point.
+
+```js
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true})
+//=> '…rainbow dragons'
+
+// without preferTruncationOnSpace
+cliTruncate('unicorns rainbow dragons', 20, {position: 'start'})
+//=> '…rns rainbow dragons'
+
+cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true})
+//=> 'unicorns…dragons'
+
+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})
+//=> '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
 
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)
+---
+
+<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>