wrap-ansi 3.0.0 → 5.1.0

package/index.js

@@ -1,6 +1,7 @@
 'use strict';
 const stringWidth = require('string-width');
 const stripAnsi = require('strip-ansi');
+const ansiStyles = require('ansi-styles');
 
 const ESCAPES = new Set([
 	'\u001B',
@@ -9,63 +10,33 @@ const ESCAPES = new Set([
 
 const END_CODE = 39;
 
-const ESCAPE_CODES = new Map([
-	[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]
-]);
-
 const wrapAnsi = code => `${ESCAPES.values().next().value}[${code}m`;
 
 // Calculate the length of words split on ' ', ignoring
 // the extra characters added by ansi escape codes
-const wordLengths = str => str.split(' ').map(s => stringWidth(s));
+const wordLengths = string => string.split(' ').map(character => stringWidth(character));
 
 // Wrap a long word across multiple rows
 // Ansi escape codes do not count towards length
-const wrapWord = (rows, word, cols) => {
-	const arr = Array.from(word);
+const wrapWord = (rows, word, columns) => {
+	const characters = [...word];
 
 	let insideEscape = false;
 	let visible = stringWidth(stripAnsi(rows[rows.length - 1]));
 
-	for (const item of arr.entries()) {
-		const i = item[0];
-		const char = item[1];
-		const charLength = stringWidth(char);
+	for (const [index, character] of characters.entries()) {
+		const characterLength = stringWidth(character);
 
-		if (visible + charLength <= cols) {
-			rows[rows.length - 1] += char;
+		if (visible + characterLength <= columns) {
+			rows[rows.length - 1] += character;
 		} else {
-			rows.push(char);
+			rows.push(character);
 			visible = 0;
 		}
 
-		if (ESCAPES.has(char)) {
+		if (ESCAPES.has(character)) {
 			insideEscape = true;
-		} else if (insideEscape && char === 'm') {
+		} else if (insideEscape && character === 'm') {
 			insideEscape = false;
 			continue;
 		}
@@ -74,9 +45,9 @@ const wrapWord = (rows, word, cols) => {
 			continue;
 		}
 
-		visible += charLength;
+		visible += characterLength;
 
-		if (visible === cols && i < arr.length - 1) {
+		if (visible === columns && index < characters.length - 1) {
 			rows.push('');
 			visible = 0;
 		}
@@ -89,88 +60,116 @@ const wrapWord = (rows, word, cols) => {
 	}
 };
 
+// Trims spaces from a string ignoring invisible sequences
+const stringVisibleTrimSpacesRight = str => {
+	const words = str.split(' ');
+	let last = words.length;
+
+	while (last > 0) {
+		if (stringWidth(words[last - 1]) > 0) {
+			break;
+		}
+
+		last--;
+	}
+
+	if (last === words.length) {
+		return str;
+	}
+
+	return words.slice(0, last).join(' ') + words.slice(last).join('');
+};
+
 // 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
+// than columns characters
 //
 // 'soft' allows long words to expand past the column length
-const exec = (str, cols, opts) => {
-	const options = opts || {};
+const exec = (string, columns, options = {}) => {
+	if (options.trim !== false && string.trim() === '') {
+		return '';
+	}
 
 	let pre = '';
 	let ret = '';
 	let escapeCode;
 
-	const lengths = wordLengths(str);
-	const words = str.split(' ');
-	const rows = [''];
+	const lengths = wordLengths(string);
+	let rows = [''];
 
-	for (const item of Array.from(words).entries()) {
-		const i = item[0];
-		const word = item[1];
+	for (const [index, word] of string.split(' ').entries()) {
+		if (options.trim !== false) {
+			rows[rows.length - 1] = rows[rows.length - 1].trimLeft();
+		}
 
-		rows[rows.length - 1] = options.trim === false ? rows[rows.length - 1] : rows[rows.length - 1].trim();
 		let rowLength = stringWidth(rows[rows.length - 1]);
 
-		if (rowLength || word === '') {
-			if (rowLength === cols && options.wordWrap === false) {
+		if (index !== 0) {
+			if (rowLength >= columns && (options.wordWrap === false || options.trim === false)) {
 				// If we start with a new word but the current row length equals the length of the columns, add a new row
 				rows.push('');
 				rowLength = 0;
 			}
 
-			rows[rows.length - 1] += ' ';
-			rowLength++;
+			if (rowLength > 0 || options.trim === false) {
+				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) {
+		// never allowed to extend past 'columns'
+		if (options.hard && lengths[index] > columns) {
+			const remainingColumns = (columns - rowLength);
+			const breaksStartingThisLine = 1 + Math.floor((lengths[index] - remainingColumns - 1) / columns);
+			const breaksStartingNextLine = Math.floor((lengths[index] - 1) / columns);
+			if (breaksStartingNextLine < breaksStartingThisLine) {
 				rows.push('');
 			}
-			wrapWord(rows, word, cols);
+
+			wrapWord(rows, word, columns);
 			continue;
 		}
 
-		if (rowLength + lengths[i] > cols && rowLength > 0) {
-			if (options.wordWrap === false && rowLength < cols) {
-				wrapWord(rows, word, cols);
+		if (rowLength + lengths[index] > columns && rowLength > 0 && lengths[index] > 0) {
+			if (options.wordWrap === false && rowLength < columns) {
+				wrapWord(rows, word, columns);
 				continue;
 			}
 
 			rows.push('');
 		}
 
-		if (rowLength + lengths[i] > cols && options.wordWrap === false) {
-			wrapWord(rows, word, cols);
+		if (rowLength + lengths[index] > columns && options.wordWrap === false) {
+			wrapWord(rows, word, columns);
 			continue;
 		}
 
 		rows[rows.length - 1] += word;
 	}
 
-	pre = rows.map(r => options.trim === false ? r : r.trim()).join('\n');
+	if (options.trim !== false) {
+		rows = rows.map(stringVisibleTrimSpacesRight);
+	}
 
-	for (const item of Array.from(pre).entries()) {
-		const i = item[0];
-		const char = item[1];
+	pre = rows.join('\n');
 
-		ret += char;
+	for (const [index, character] of [...pre].entries()) {
+		ret += character;
 
-		if (ESCAPES.has(char)) {
-			const code = parseFloat(/\d[^m]*/.exec(pre.slice(i, i + 4)));
+		if (ESCAPES.has(character)) {
+			const code = parseFloat(/\d[^m]*/.exec(pre.slice(index, index + 4)));
 			escapeCode = code === END_CODE ? null : code;
 		}
 
-		const code = ESCAPE_CODES.get(Number(escapeCode));
+		const code = ansiStyles.codes.get(Number(escapeCode));
 
 		if (escapeCode && code) {
-			if (pre[i + 1] === '\n') {
+			if (pre[index + 1] === '\n') {
 				ret += wrapAnsi(code);
-			} else if (char === '\n') {
+			} else if (character === '\n') {
 				ret += wrapAnsi(escapeCode);
 			}
 		}
@@ -180,10 +179,10 @@ const exec = (str, cols, opts) => {
 };
 
 // For each newline, invoke the method separately
-module.exports = (str, cols, opts) => {
-	return String(str)
+module.exports = (string, columns, options) => {
+	return String(string)
 		.normalize()
 		.split('\n')
-		.map(line => exec(line, cols, opts))
+		.map(line => exec(line, columns, options))
 		.join('\n');
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrap-ansi",
-	"version": "3.0.0",
+	"version": "5.1.0",
 	"description": "Wordwrap a string with ANSI escape codes",
 	"license": "MIT",
 	"repository": "chalk/wrap-ansi",
@@ -10,11 +10,10 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=4"
+		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && nyc ava",
-		"coveralls": "nyc report --reporter=text-lcov | coveralls"
+		"test": "xo && nyc ava"
 	},
 	"files": [
 		"index.js"
@@ -47,16 +46,16 @@
 		"text"
 	],
 	"dependencies": {
-		"string-width": "^2.1.1",
-		"strip-ansi": "^4.0.0"
+		"ansi-styles": "^3.2.0",
+		"string-width": "^3.0.0",
+		"strip-ansi": "^5.0.0"
 	},
 	"devDependencies": {
-		"ava": "^0.21.0",
-		"chalk": "^2.0.1",
-		"coveralls": "^2.11.4",
+		"ava": "^1.2.1",
+		"chalk": "^2.4.2",
+		"coveralls": "^3.0.3",
 		"has-ansi": "^3.0.0",
-		"nyc": "^11.0.3",
-		"strip-ansi": "^4.0.0",
-		"xo": "^0.18.2"
+		"nyc": "^13.3.0",
+		"xo": "^0.24.0"
 	}
 }

package/readme.md

@@ -24,6 +24,20 @@ console.log(wrapAnsi(input, 20));
 
 <img width="331" src="screenshot.png">
 
+---
+
+<div align="center">
+	<b>
+		<a href="https://tidelift.com/subscription/pkg/npm-wrap_ansi?utm_source=npm-wrap-ansi&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>
+
+---
+
 
 ## API
 
@@ -84,6 +98,11 @@ Whitespace on all lines is removed by default. Set this option to `false` if you
 - [Benjamin Coe](https://github.com/bcoe)
 
 
+## Security
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
+
+
 ## License
 
 MIT