cli-truncate 0.2.1 → 2.1.0

package/index.d.ts

@@ -0,0 +1,96 @@
+declare namespace cliTruncate {
+	interface Options {
+		/**
+		Position to truncate the string.
+
+		@default 'end'
+		*/
+		readonly position?: 'start' | 'middle' | 'end';
+
+		/**
+		Add a space between the text and the ellipsis.
+
+		@default false
+
+		@example
+		```
+		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
+		```
+		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;
+	}
+}
+
+/**
+Truncate a string to a specific width in the terminal.
+
+@param text - Text to truncate.
+@param columns - Columns to occupy in the terminal.
+
+@example
+```
+import cliTruncate = require('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…'
+```
+*/
+declare function cliTruncate(
+	text: string,
+	columns: number,
+	options?: cliTruncate.Options
+): string;
+
+export = cliTruncate;

package/index.js

@@ -1,19 +1,42 @@
 'use strict';
-var sliceAnsi = require('slice-ansi');
-var stringWidth = require('string-width');
+const sliceAnsi = require('slice-ansi');
+const stringWidth = require('string-width');
 
-module.exports = function (input, columns, options) {
-	options = options || {};
+function getIndexOfNearestSpace(string, index, shouldSearchRight) {
+	if (string.charAt(index) === ' ') {
+		return index;
+	}
+
+	for (let i = 1; i <= 3; i++) {
+		if (shouldSearchRight) {
+			if (string.charAt(index + i) === ' ') {
+				return index + i;
+			}
+		} else if (string.charAt(index - i) === ' ') {
+			return index - i;
+		}
+	}
+
+	return index;
+}
 
-	var position = options.position || 'end';
-	var ellipsis = '…';
+module.exports = (text, columns, options) => {
+	options = {
+		position: 'end',
+		preferTruncationOnSpace: false,
+		...options
+	};
 
-	if (typeof input !== 'string') {
-		throw new TypeError('Expected `input` to be a string, got ' + typeof input);
+	const {position, space, preferTruncationOnSpace} = options;
+	let ellipsis = '…';
+	let ellipsisWidth = 1;
+
+	if (typeof text !== 'string') {
+		throw new TypeError(`Expected \`input\` to be a string, got ${typeof text}`);
 	}
 
 	if (typeof columns !== 'number') {
-		throw new TypeError('Expected `columns` to be a number, got ' + typeof columns);
+		throw new TypeError(`Expected \`columns\` to be a number, got ${typeof columns}`);
 	}
 
 	if (columns < 1) {
@@ -24,20 +47,60 @@ module.exports = function (input, columns, options) {
 		return ellipsis;
 	}
 
-	var 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') {
-		var 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 nearestSpace = getIndexOfNearestSpace(text, length - columns + 1, true);
+			return ellipsis + sliceAnsi(text, nearestSpace, length).trim();
+		}
+
+		if (space === true) {
+			ellipsis += ' ';
+			ellipsisWidth = 2;
+		}
+
+		return ellipsis + sliceAnsi(text, length - columns + ellipsisWidth, length);
+	}
+
+	if (position === 'middle') {
+		if (space === true) {
+			ellipsis = ' ' + ellipsis + ' ';
+			ellipsisWidth = 3;
+		}
+
+		const half = Math.floor(columns / 2);
+
+		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, half) +
+			ellipsis +
+			sliceAnsi(text, length - (columns - half) + ellipsisWidth, length)
+		);
+	}
+
+	if (position === 'end') {
+		if (preferTruncationOnSpace) {
+			const nearestSpace = getIndexOfNearestSpace(text, columns - 1);
+			return sliceAnsi(text, 0, nearestSpace) + ellipsis;
+		}
+
+		if (space === true) {
+			ellipsis = ' ' + ellipsis;
+			ellipsisWidth = 2;
+		}
+
+		return sliceAnsi(text, 0, columns - ellipsisWidth) + ellipsis;
 	}
 
-	throw new Error('Expected `options.position` to be either `start`, `middle` or `end`, got ' + position);
+	throw new Error(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);
 };

package/license

@@ -1,21 +1,9 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (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:
+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:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,42 +1,46 @@
 {
-  "name": "cli-truncate",
-  "version": "0.2.1",
-  "description": "Truncate a string to a specific width in the terminal",
-  "license": "MIT",
-  "repository": "sindresorhus/cli-truncate",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=0.10.0"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "truncate",
-    "ellipsis",
-    "text",
-    "limit",
-    "slice",
-    "cli",
-    "terminal",
-    "term",
-    "shell",
-    "width",
-    "ansi"
-  ],
-  "dependencies": {
-    "slice-ansi": "0.0.4",
-    "string-width": "^1.0.1"
-  },
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  }
+	"name": "cli-truncate",
+	"version": "2.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"
+	},
+	"engines": {
+		"node": ">=8"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"truncate",
+		"ellipsis",
+		"text",
+		"limit",
+		"slice",
+		"cli",
+		"terminal",
+		"term",
+		"shell",
+		"width",
+		"ansi",
+		"string"
+	],
+	"dependencies": {
+		"slice-ansi": "^3.0.0",
+		"string-width": "^4.2.0"
+	},
+	"devDependencies": {
+		"ava": "^2.1.0",
+		"tsd": "^0.11.0",
+		"xo": "^0.25.3"
+	}
 }

package/readme.md

@@ -2,16 +2,14 @@
 
 > 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).
-
+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 --save cli-truncate
+$ npm install cli-truncate
 ```
 
-
 ## Usage
 
 ```js
@@ -20,28 +18,38 @@ const cliTruncate = require('cli-truncate');
 cliTruncate('unicorn', 4);
 //=> 'uni…'
 
-// truncate at different positions
+// 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…'
+cliTruncate('unicorns rainbow dragons', 6, {position: 'end'})
+//=> 'unico…'
+
+cliTruncate('\u001B[31municorn\u001B[39m', 4);
+//=> '\u001B[31muni\u001B[39m…'
+
+// Truncate Unicode surrogate pairs
+cliTruncate('uni\uD83C\uDE00corn', 5);
+//=> 'uni\uD83C\uDE00…'
 
-// truncate the paragraph to the terminal width
+// 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…'
 ```
 
-
 ## API
 
-### cliTruncate(input, columns, [options])
+### cliTruncate(text, columns, options?)
 
-#### input
+#### text
 
 Type: `string`
 
@@ -55,14 +63,62 @@ Columns to occupy in the terminal.
 
 #### options
 
+Type: `object`
+
 ##### position
 
-Type: `string`<br>
-Default: `'end'`<br>
-Values: `'start'`, `'middle'`, `'end'`
+Type: `string`\
+Default: `'end'`\
+Values: `'start'` `'middle'` `'end'`
 
 Position to truncate the string.
 
+##### space
+
+Type: `boolean`\
+Default: `false`
+
+Add a space between the text and the ellipsis.
+
+```js
+cliTruncate('unicorns', 5, {space: false});
+//=> 'unic…'
+
+cliTruncate('unicorns', 5, {space: true});
+//=> 'uni …'
+
+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
+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'
+```
 
 ## Related
 
@@ -70,6 +126,14 @@ Position to truncate the string.
 - [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>