init

Author: sindresorhus

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{package.json,*.yml}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitignore

@@ -0,0 +1 @@
+node_modules

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - '5'
+  - '4'
+  - '0.12'
+  - '0.10'

index.js

@@ -0,0 +1,29 @@
+'use strict';
+var wrapAnsi = require('wrap-ansi');
+var stringWidth = require('string-width');
+
+module.exports = function (input, columns) {
+	var ellipsis = '…';
+
+	if (typeof input !== 'string') {
+		throw new TypeError('Expected `input` to be a string, got ' + typeof input);
+	}
+
+	if (typeof columns !== 'number') {
+		throw new TypeError('Expected `columns` to be a number, got ' + typeof columns);
+	}
+
+	if (columns < 1) {
+		return '';
+	}
+
+	if (columns === 1) {
+		return ellipsis;
+	}
+
+	if (stringWidth(input) <= columns) {
+		return input;
+	}
+
+	return wrapAnsi(input, columns - 1, {hard: true}).split('\n')[0] + ellipsis;
+};

license

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Sindre Sorhus <[email protected]> (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:
+
+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.

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "cli-truncate",
+  "version": "0.0.0",
+  "description": "Truncate a string to a specific width in the terminal",
+  "license": "MIT",
+  "repository": "sindresorhus/cli-truncate",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "[email protected]",
+    "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": {
+    "string-width": "^1.0.1",
+    "wrap-ansi": "^2.0.0"
+  },
+  "devDependencies": {
+    "ava": "*",
+    "xo": "*"
+  }
+}

readme.md

@@ -0,0 +1,58 @@
+# cli-truncate [![Build Status](https://travis-ci.org/sindresorhus/cli-truncate.svg?branch=master)](https://travis-ci.org/sindresorhus/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).
+
+
+## Install
+
+```
+$ npm install --save cli-truncate
+```
+
+
+## Usage
+
+```js
+const cliTruncate = require('cli-truncate');
+
+cliTruncate('unicorn', 4);
+//=> 'uni…'
+
+cliTruncate('\u001b[31municorn\u001b[39m', 4);
+//=> '\u001b[31muni\u001b[39m…'
+
+// 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)
+
+#### input
+
+Type: `string`
+
+Text to truncate.
+
+#### columns
+
+Type: `number`
+
+Columns to occupy in the terminal.
+
+
+## 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)

test.js

@@ -0,0 +1,18 @@
+import test from 'ava';
+import m from './';
+
+test(t => {
+	t.is(m('unicorn', 4), 'uni…');
+	t.is(m('unicorn', 1), '…');
+	t.is(m('unicorn', 0), '');
+	t.is(m('unicorn', -4), '');
+	t.is(m('unicorn', 20), 'unicorn');
+	t.is(m('unicorn', 7), 'unicorn');
+	t.is(m('unicorn', 6), 'unico…');
+	t.is(m('\u001b[31municorn\u001b[39m', 7), '\u001b[31municorn\u001b[39m');
+	t.is(m('\u001b[31municorn\u001b[39m', 1), '…');
+	t.is(m('\u001b[31municorn\u001b[39m', 4), '\u001b[31muni\u001b[39m…');
+	// TODO
+	t.skip.is(m('a\ud83c\ude00b\ud83c\ude00c', 5), 'a\ud83c\ude00b…', 'surrogate pairs');
+	t.skip.is(m('안녕하세요', 3), '안…', 'wide char');
+});