wrap-ansi 0.1.0 → 2.0.0

package/index.js

@@ -1,18 +1,65 @@
 'use strict';
-var spliceString = require('splice-string');
+var stringWidth = require('string-width');
 
-module.exports = function (str, cols) {
-	var ret = '';
+var ESCAPES = [
+	'\u001b',
+	'\u009b'
+];
+
+var END_CODE = 39;
+
+var ESCAPE_CODES = {
+	0: 0,
+	1: 22,
+	2: 22,
+	3: 23,
+	4: 24,
+	7: 27,
+	8: 28,
+	9: 29,
+	30: 39,
+	31: 39,
+	32: 39,
+	33: 39,
+	34: 39,
+	35: 39,
+	36: 39,
+	37: 39,
+	90: 39,
+	40: 49,
+	41: 49,
+	42: 49,
+	43: 49,
+	44: 49,
+	45: 49,
+	46: 49,
+	47: 49
+};
+
+function wrapAnsi(code) {
+	return ESCAPES[0] + '[' + code + 'm';
+}
+
+// calculate the length of words split on ' ', ignoring
+// the extra characters added by ansi escape codes.
+function wordLengths(str) {
+	return str.split(' ').map(function (s) {
+		return stringWidth(s);
+	});
+}
+
+// wrap a long word across multiple rows.
+// ansi escape codes do not count towards length.
+function wrapWord(rows, word, cols) {
 	var insideEscape = false;
-	var visible = 0;
-	var lastSpace = 0;
+	var visible = rows[rows.length - 1].length;
 
-	for (var i = 0; i < str.length; i++) {
-		var x = str[i];
+	for (var i = 0; i < word.length; i++) {
+		var x = word[i];
 
-		ret += x;
+		rows[rows.length - 1] += x;
 
-		if (x === '\u001b') {
+		if (ESCAPES.indexOf(x) !== -1) {
 			insideEscape = true;
 		} else if (insideEscape && x === 'm') {
 			insideEscape = false;
@@ -23,16 +70,93 @@ module.exports = function (str, cols) {
 			continue;
 		}
 
-		if (x === ' ') {
-			lastSpace = i;
-		}
+		visible++;
 
-		if (++visible >= cols - 2 && lastSpace > 0) {
-			ret = spliceString(ret, lastSpace, 1, '\n');
-			lastSpace = 0;
+		if (visible >= cols && i < word.length - 1) {
+			rows.push('');
 			visible = 0;
 		}
 	}
 
+	// it's possible that the last row we copy over is only
+	// ansi escape characters, handle this edge-case.
+	if (!visible && rows[rows.length - 1].length > 0 && rows.length > 1) {
+		rows[rows.length - 2] += rows.pop();
+	}
+}
+
+// the wrap-ansi module can be invoked
+// in either 'hard' or 'soft' wrap mode.
+//
+// 'hard' will never allow a string to take up more
+// than cols characters.
+//
+// 'soft' allows long words to expand past the column length.
+function exec(str, cols, opts) {
+	var options = opts || {};
+
+	var pre = '';
+	var ret = '';
+	var escapeCode;
+
+	var lengths = wordLengths(str);
+	var words = str.split(' ');
+	var rows = [''];
+
+	for (var i = 0, word; (word = words[i]) !== undefined; i++) {
+		var rowLength = stringWidth(rows[rows.length - 1]);
+
+		if (rowLength) {
+			rows[rows.length - 1] += ' ';
+			rowLength++;
+		}
+
+		// in 'hard' wrap mode, the length of a line is
+		// never allowed to extend past 'cols'.
+		if (lengths[i] > cols && options.hard) {
+			if (rowLength) {
+				rows.push('');
+			}
+			wrapWord(rows, word, cols);
+			continue;
+		}
+
+		if (rowLength + lengths[i] > cols && rowLength > 0) {
+			rows.push('');
+		}
+
+		rows[rows.length - 1] += word;
+	}
+
+	pre = rows.map(function (r) {
+		return r.trim();
+	}).join('\n');
+
+	for (var j = 0; j < pre.length; j++) {
+		var y = pre[j];
+
+		ret += y;
+
+		if (ESCAPES.indexOf(y) !== -1) {
+			var code = parseFloat(/[0-9][^m]*/.exec(pre.slice(j, j + 4)));
+			escapeCode = code === END_CODE ? null : code;
+		}
+
+		if (escapeCode && ESCAPE_CODES[escapeCode]) {
+			if (pre[j + 1] === '\n') {
+				ret += wrapAnsi(ESCAPE_CODES[escapeCode]);
+			} else if (y === '\n') {
+				ret += wrapAnsi(escapeCode);
+			}
+		}
+	}
+
 	return ret;
+}
+
+// for each line break, invoke the method separately.
+module.exports = function (str, cols, opts) {
+	return String(str).split('\n').map(function (substr) {
+		return exec(substr, cols, opts);
+	}).join('\n');
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrap-ansi",
-  "version": "0.1.0",
+  "version": "2.0.0",
   "description": "Wordwrap a string with ANSI escape codes",
   "license": "MIT",
   "repository": "chalk/wrap-ansi",
@@ -12,13 +12,15 @@
   "maintainers": [
     "Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)",
     "Joshua Appelman <jappelman@xebia.com> (jbnicolai.com)",
-    "JD Ballard <i.am.qix@gmail.com> (github.com/qix-)"
+    "JD Ballard <i.am.qix@gmail.com> (github.com/qix-)",
+    "Benjamin Coe <ben@npmjs.com> (github.com/bcoe)"
   ],
   "engines": {
     "node": ">=0.10.0"
   },
   "scripts": {
-    "test": "xo && node test.js"
+    "test": "xo && nyc node test.js",
+    "coverage": "nyc --reporter=text-lcov node test.js | coveralls"
   },
   "files": [
     "index.js"
@@ -51,11 +53,14 @@
     "text"
   ],
   "dependencies": {
-    "splice-string": "^1.0.0"
+    "string-width": "^1.0.1"
   },
   "devDependencies": {
     "ava": "0.0.4",
     "chalk": "^1.1.0",
+    "coveralls": "^2.11.4",
+    "has-ansi": "^2.0.0",
+    "nyc": "^3.2.2",
     "strip-ansi": "^3.0.0",
     "xo": "*"
   }

package/readme.md

@@ -1,4 +1,4 @@
-# wrap-ansi [![Build Status](https://travis-ci.org/chalk/wrap-ansi.svg?branch=master)](https://travis-ci.org/chalk/wrap-ansi)
+# wrap-ansi [![Build Status](https://travis-ci.org/chalk/wrap-ansi.svg?branch=master)](https://travis-ci.org/chalk/wrap-ansi) [![Coverage Status](https://coveralls.io/repos/chalk/wrap-ansi/badge.svg?branch=master&service=github)](https://coveralls.io/github/chalk/wrap-ansi?branch=master)
 
 > Wordwrap a string with [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles)
 
@@ -13,10 +13,10 @@ $ npm install --save wrap-ansi
 ## Usage
 
 ```js
-var chalk = require('chalk');
-var wrapAnsi = require('wrap-ansi');
+const chalk = require('chalk');
+const wrapAnsi = require('wrap-ansi');
 
-var input = 'The quick brown ' + chalk.red('fox jumped over ') +
+const input = 'The quick brown ' + chalk.red('fox jumped over ') +
 	'the lazy ' + chalk.green('dog and then ran away with the unicorn.');
 
 console.log(wrapAnsi(input, 20));
@@ -27,7 +27,9 @@ console.log(wrapAnsi(input, 20));
 
 ## API
 
-### wrapAnsi(input, columns)
+### wrapAnsi(input, columns, [options])
+
+Wrap words to the specified column width.
 
 #### input
 
@@ -41,10 +43,19 @@ Type: `number`
 
 Number of columns to wrap the text to.
 
+#### options.hard
+
+Type: `boolean`  
+Default: `false`
+
+By default the wrap is soft, meaning long words may extend past the column width. Setting this to `true` will make it hard wrap at the column width.
+
 
 ## Related
 
+- [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
 - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
+- [jsesc](https://github.com/mathiasbynens/jsesc) - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.
 
 
 ## License