wrap-ansi 5.1.0 → 7.0.0

package/index.js

@@ -10,7 +10,14 @@ const ESCAPES = new Set([
 
 const END_CODE = 39;
 
-const wrapAnsi = code => `${ESCAPES.values().next().value}[${code}m`;
+const ANSI_ESCAPE_BELL = '\u0007';
+const ANSI_CSI = '[';
+const ANSI_OSC = ']';
+const ANSI_SGR_TERMINATOR = 'm';
+const ANSI_ESCAPE_LINK = `${ANSI_OSC}8;;`;
+
+const wrapAnsi = code => `${ESCAPES.values().next().value}${ANSI_CSI}${code}${ANSI_SGR_TERMINATOR}`;
+const wrapAnsiHyperlink = uri => `${ESCAPES.values().next().value}${ANSI_ESCAPE_LINK}${uri}${ANSI_ESCAPE_BELL}`;
 
 // Calculate the length of words split on ' ', ignoring
 // the extra characters added by ansi escape codes
@@ -21,7 +28,8 @@ const wordLengths = string => string.split(' ').map(character => stringWidth(cha
 const wrapWord = (rows, word, columns) => {
 	const characters = [...word];
 
-	let insideEscape = false;
+	let isInsideEscape = false;
+	let isInsideLinkEscape = false;
 	let visible = stringWidth(stripAnsi(rows[rows.length - 1]));
 
 	for (const [index, character] of characters.entries()) {
@@ -35,13 +43,20 @@ const wrapWord = (rows, word, columns) => {
 		}
 
 		if (ESCAPES.has(character)) {
-			insideEscape = true;
-		} else if (insideEscape && character === 'm') {
-			insideEscape = false;
-			continue;
+			isInsideEscape = true;
+			isInsideLinkEscape = characters.slice(index + 1).join('').startsWith(ANSI_ESCAPE_LINK);
 		}
 
-		if (insideEscape) {
+		if (isInsideEscape) {
+			if (isInsideLinkEscape) {
+				if (character === ANSI_ESCAPE_BELL) {
+					isInsideEscape = false;
+					isInsideLinkEscape = false;
+				}
+			} else if (character === ANSI_SGR_TERMINATOR) {
+				isInsideEscape = false;
+			}
+
 			continue;
 		}
 
@@ -61,8 +76,8 @@ const wrapWord = (rows, word, columns) => {
 };
 
 // Trims spaces from a string ignoring invisible sequences
-const stringVisibleTrimSpacesRight = str => {
-	const words = str.split(' ');
+const stringVisibleTrimSpacesRight = string => {
+	const words = string.split(' ');
 	let last = words.length;
 
 	while (last > 0) {
@@ -74,17 +89,15 @@ const stringVisibleTrimSpacesRight = str => {
 	}
 
 	if (last === words.length) {
-		return str;
+		return string;
 	}
 
 	return words.slice(0, last).join(' ') + words.slice(last).join('');
 };
 
-// The wrap-ansi module can be invoked
-// in either 'hard' or 'soft' wrap mode
+// 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 = {}) => {
@@ -92,16 +105,16 @@ const exec = (string, columns, options = {}) => {
 		return '';
 	}
 
-	let pre = '';
-	let ret = '';
+	let returnValue = '';
 	let escapeCode;
+	let escapeUrl;
 
 	const lengths = wordLengths(string);
 	let rows = [''];
 
 	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] = rows[rows.length - 1].trimStart();
 		}
 
 		let rowLength = stringWidth(rows[rows.length - 1]);
@@ -119,8 +132,7 @@ const exec = (string, columns, options = {}) => {
 			}
 		}
 
-		// 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);
@@ -154,34 +166,50 @@ const exec = (string, columns, options = {}) => {
 		rows = rows.map(stringVisibleTrimSpacesRight);
 	}
 
-	pre = rows.join('\n');
+	const pre = [...rows.join('\n')];
 
-	for (const [index, character] of [...pre].entries()) {
-		ret += character;
+	for (const [index, character] of pre.entries()) {
+		returnValue += character;
 
 		if (ESCAPES.has(character)) {
-			const code = parseFloat(/\d[^m]*/.exec(pre.slice(index, index + 4)));
-			escapeCode = code === END_CODE ? null : code;
+			const {groups} = new RegExp(`(?:\\${ANSI_CSI}(?<code>\\d+)m|\\${ANSI_ESCAPE_LINK}(?<uri>.*)${ANSI_ESCAPE_BELL})`).exec(pre.slice(index).join('')) || {groups: {}};
+			if (groups.code !== undefined) {
+				const code = Number.parseFloat(groups.code);
+				escapeCode = code === END_CODE ? undefined : code;
+			} else if (groups.uri !== undefined) {
+				escapeUrl = groups.uri.length === 0 ? undefined : groups.uri;
+			}
 		}
 
 		const code = ansiStyles.codes.get(Number(escapeCode));
 
-		if (escapeCode && code) {
-			if (pre[index + 1] === '\n') {
-				ret += wrapAnsi(code);
-			} else if (character === '\n') {
-				ret += wrapAnsi(escapeCode);
+		if (pre[index + 1] === '\n') {
+			if (escapeUrl) {
+				returnValue += wrapAnsiHyperlink('');
+			}
+
+			if (escapeCode && code) {
+				returnValue += wrapAnsi(code);
+			}
+		} else if (character === '\n') {
+			if (escapeCode && code) {
+				returnValue += wrapAnsi(escapeCode);
+			}
+
+			if (escapeUrl) {
+				returnValue += wrapAnsiHyperlink(escapeUrl);
 			}
 		}
 	}
 
-	return ret;
+	return returnValue;
 };
 
 // For each newline, invoke the method separately
 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/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://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:
 

package/package.json

@@ -1,16 +1,17 @@
 {
 	"name": "wrap-ansi",
-	"version": "5.1.0",
+	"version": "7.0.0",
 	"description": "Wordwrap a string with ANSI escape codes",
 	"license": "MIT",
 	"repository": "chalk/wrap-ansi",
+	"funding": "https://github.com/chalk/wrap-ansi?sponsor=1",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=6"
+		"node": ">=10"
 	},
 	"scripts": {
 		"test": "xo && nyc ava"
@@ -46,16 +47,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",
-		"chalk": "^2.4.2",
+		"ava": "^2.1.0",
+		"chalk": "^4.0.0",
 		"coveralls": "^3.0.3",
-		"has-ansi": "^3.0.0",
-		"nyc": "^13.3.0",
-		"xo": "^0.24.0"
+		"has-ansi": "^4.0.0",
+		"nyc": "^15.0.1",
+		"xo": "^0.29.1"
 	}
 }

package/readme.md

@@ -1,15 +1,13 @@
-# 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/github/chalk/wrap-ansi/badge.svg?branch=master)](https://coveralls.io/github/chalk/wrap-ansi?branch=master)
+# wrap-ansi [![Build Status](https://travis-ci.com/chalk/wrap-ansi.svg?branch=master)](https://travis-ci.com/chalk/wrap-ansi) [![Coverage Status](https://coveralls.io/repos/github/chalk/wrap-ansi/badge.svg?branch=master)](https://coveralls.io/github/chalk/wrap-ansi?branch=master)
 
 > Wordwrap a string with [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles)
 
-
 ## Install
 
 ```
 $ npm install wrap-ansi
 ```
 
-
 ## Usage
 
 ```js
@@ -24,32 +22,17 @@ 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
 
-### 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
 
@@ -59,30 +42,29 @@ Number of columns to wrap the text to.
 
 #### options
 
-Type: `Object`
+Type: `object`
 
 ##### hard
 
-Type: `boolean`<br>
+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.
 
 ##### wordWrap
 
-Type: `boolean`<br>
+Type: `boolean`\
 Default: `true`
 
 By default, an attempt is made to split words at spaces, ensuring that they don't extend past the configured columns. If wordWrap is `false`, each column will instead be completely filled splitting words as necessary.
 
 ##### trim
 
-Type: `boolean`<br>
+Type: `boolean`\
 Default: `true`
 
 Whitespace on all lines is removed by default. Set this option to `false` if you don't want to trim.
 
-
 ## Related
 
 - [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
@@ -90,19 +72,20 @@ Whitespace on all lines is removed by default. Set this option to `false` if you
 - [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.
 
-
 ## Maintainers
 
 - [Sindre Sorhus](https://github.com/sindresorhus)
 - [Josh Junon](https://github.com/qix-)
 - [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
+<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>