wrap-ansi 5.0.0 → 6.2.0

package/index.js

@@ -21,7 +21,7 @@ const wordLengths = string => string.split(' ').map(character => stringWidth(cha
 const wrapWord = (rows, word, columns) => {
 	const characters = [...word];
 
-	let insideEscape = false;
+	let isInsideEscape = false;
 	let visible = stringWidth(stripAnsi(rows[rows.length - 1]));
 
 	for (const [index, character] of characters.entries()) {
@@ -35,13 +35,13 @@ const wrapWord = (rows, word, columns) => {
 		}
 
 		if (ESCAPES.has(character)) {
-			insideEscape = true;
-		} else if (insideEscape && character === 'm') {
-			insideEscape = false;
+			isInsideEscape = true;
+		} else if (isInsideEscape && character === 'm') {
+			isInsideEscape = false;
 			continue;
 		}
 
-		if (insideEscape) {
+		if (isInsideEscape) {
 			continue;
 		}
 
@@ -60,11 +60,29 @@ const wrapWord = (rows, word, columns) => {
 	}
 };
 
-// The wrap-ansi module can be invoked
-// in either 'hard' or 'soft' wrap mode
+// 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 columns characters
+// 'hard' will never allow a string to take up more than columns characters
 //
 // 'soft' allows long words to expand past the column length
 const exec = (string, columns, options = {}) => {
@@ -77,7 +95,7 @@ const exec = (string, columns, options = {}) => {
 	let escapeCode;
 
 	const lengths = wordLengths(string);
-	const rows = [''];
+	let rows = [''];
 
 	for (const [index, word] of string.split(' ').entries()) {
 		if (options.trim !== false) {
@@ -87,18 +105,19 @@ const exec = (string, columns, options = {}) => {
 		let rowLength = stringWidth(rows[rows.length - 1]);
 
 		if (index !== 0) {
-			if (rowLength === columns && (options.wordWrap === false || options.trim === false)) {
+			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 'columns'
+		// In 'hard' wrap mode, the length of a line is 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);
@@ -111,7 +130,7 @@ const exec = (string, columns, options = {}) => {
 			continue;
 		}
 
-		if (rowLength + lengths[index] > columns && rowLength > 0) {
+		if (rowLength + lengths[index] > columns && rowLength > 0 && lengths[index] > 0) {
 			if (options.wordWrap === false && rowLength < columns) {
 				wrapWord(rows, word, columns);
 				continue;
@@ -128,7 +147,11 @@ const exec = (string, columns, options = {}) => {
 		rows[rows.length - 1] += word;
 	}
 
-	pre = rows.map(row => options.trim === false ? row : row.trim()).join('\n');
+	if (options.trim !== false) {
+		rows = rows.map(stringVisibleTrimSpacesRight);
+	}
+
+	pre = rows.join('\n');
 
 	for (const [index, character] of [...pre].entries()) {
 		ret += character;
@@ -156,6 +179,7 @@ const exec = (string, columns, options = {}) => {
 module.exports = (string, columns, options) => {
 	return String(string)
 		.normalize()
+		.replace(/\r\n/g, '\n')
 		.split('\n')
 		.map(line => exec(line, columns, options))
 		.join('\n');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrap-ansi",
-	"version": "5.0.0",
+	"version": "6.2.0",
 	"description": "Wordwrap a string with ANSI escape codes",
 	"license": "MIT",
 	"repository": "chalk/wrap-ansi",
@@ -10,7 +10,7 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=6"
+		"node": ">=8"
 	},
 	"scripts": {
 		"test": "xo && nyc ava"
@@ -46,16 +46,16 @@
 		"text"
 	],
 	"dependencies": {
-		"ansi-styles": "^3.2.0",
-		"string-width": "^3.0.0",
-		"strip-ansi": "^5.0.0"
+		"ansi-styles": "^4.0.0",
+		"string-width": "^4.1.0",
+		"strip-ansi": "^6.0.0"
 	},
 	"devDependencies": {
-		"ava": "^1.2.1",
+		"ava": "^2.1.0",
 		"chalk": "^2.4.2",
 		"coveralls": "^3.0.3",
 		"has-ansi": "^3.0.0",
-		"nyc": "^13.3.0",
+		"nyc": "^14.1.1",
 		"xo": "^0.24.0"
 	}
 }

package/readme.md

@@ -27,15 +27,15 @@ console.log(wrapAnsi(input, 20));
 
 ## API
 
-### wrapAnsi(input, columns, [options])
+### wrapAnsi(string, columns, options?)
 
 Wrap words to the specified column width.
 
-#### input
+#### string
 
 Type: `string`
 
-String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/chalk/chalk).
+String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/chalk/chalk). Newline characters will be normalized to `\n`.
 
 #### columns
 
@@ -45,7 +45,7 @@ Number of columns to wrap the text to.
 
 #### options
 
-Type: `Object`
+Type: `object`
 
 ##### hard
 
@@ -84,6 +84,14 @@ Whitespace on all lines is removed by default. Set this option to `false` if you
 - [Benjamin Coe](https://github.com/bcoe)
 
 
-## License
+---
 
-MIT
+<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>