cli-truncate 0.2.0 → 0.2.1

package/index.js

@@ -2,7 +2,10 @@
 var sliceAnsi = require('slice-ansi');
 var stringWidth = require('string-width');
 
-module.exports = function (input, columns) {
+module.exports = function (input, columns, options) {
+	options = options || {};
+
+	var position = options.position || 'end';
 	var ellipsis = '…';
 
 	if (typeof input !== 'string') {
@@ -21,9 +24,20 @@ module.exports = function (input, columns) {
 		return ellipsis;
 	}
 
-	if (stringWidth(input) <= columns) {
+	var length = stringWidth(input);
+
+	if (length <= columns) {
 		return input;
 	}
 
-	return sliceAnsi(input, 0, columns - 1) + ellipsis;
+	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;
+	}
+
+	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": "0.2.0",
+  "version": "0.2.1",
   "description": "Truncate a string to a specific width in the terminal",
   "license": "MIT",
   "repository": "sindresorhus/cli-truncate",

package/readme.md

@@ -20,6 +20,13 @@ const 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…'
 
@@ -32,7 +39,7 @@ cliTruncate(paragraph, process.stdout.columns));
 
 ## API
 
-### cliTruncate(input, columns)
+### cliTruncate(input, columns, [options])
 
 #### input
 
@@ -46,6 +53,16 @@ Type: `number`
 
 Columns to occupy in the terminal.
 
+#### options
+
+##### position
+
+Type: `string`<br>
+Default: `'end'`<br>
+Values: `'start'`, `'middle'`, `'end'`
+
+Position to truncate the string.
+
 
 ## Related