wrap-ansi 8.0.1 → 9.0.0

package/index.d.ts

@@ -0,0 +1,41 @@
+export type Options = {
+	/**
+	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.
+
+	@default false
+	*/
+	readonly hard?: boolean;
+
+	/**
+	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.
+
+	@default true
+	*/
+	readonly wordWrap?: boolean;
+
+	/**
+	Whitespace on all lines is removed by default. Set this option to `false` if you don't want to trim.
+
+	@default true
+	*/
+	readonly trim?: boolean;
+};
+
+/**
+Wrap words to the specified column width.
+
+@param string - A string with ANSI escape codes, like one styled by [`chalk`](https://github.com/chalk/chalk). Newline characters will be normalized to `\n`.
+@param columns - The number of columns to wrap the text to.
+
+@example
+```
+import chalk from 'chalk';
+import wrapAnsi from 'wrap-ansi';
+
+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));
+```
+*/
+export default function wrapAnsi(string: string, columns: number, options?: Options): string;

package/index.js

@@ -15,7 +15,7 @@ const ANSI_SGR_TERMINATOR = 'm';
 const ANSI_ESCAPE_LINK = `${ANSI_OSC}8;;`;
 
 const wrapAnsiCode = 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}`;
+const wrapAnsiHyperlink = url => `${ESCAPES.values().next().value}${ANSI_ESCAPE_LINK}${url}${ANSI_ESCAPE_BELL}`;
 
 // Calculate the length of words split on ' ', ignoring
 // the extra characters added by ansi escape codes
@@ -28,7 +28,7 @@ const wrapWord = (rows, word, columns) => {
 
 	let isInsideEscape = false;
 	let isInsideLinkEscape = false;
-	let visible = stringWidth(stripAnsi(rows[rows.length - 1]));
+	let visible = stringWidth(stripAnsi(rows.at(-1)));
 
 	for (const [index, character] of characters.entries()) {
 		const characterLength = stringWidth(character);
@@ -42,7 +42,9 @@ const wrapWord = (rows, word, columns) => {
 
 		if (ESCAPES.has(character)) {
 			isInsideEscape = true;
-			isInsideLinkEscape = characters.slice(index + 1).join('').startsWith(ANSI_ESCAPE_LINK);
+
+			const ansiEscapeLinkCandidate = characters.slice(index + 1, index + 1 + ANSI_ESCAPE_LINK.length).join('');
+			isInsideLinkEscape = ansiEscapeLinkCandidate === ANSI_ESCAPE_LINK;
 		}
 
 		if (isInsideEscape) {
@@ -68,7 +70,7 @@ const wrapWord = (rows, word, columns) => {
 
 	// 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) {
+	if (!visible && rows.at(-1).length > 0 && rows.length > 1) {
 		rows[rows.length - 2] += rows.pop();
 	}
 };
@@ -93,11 +95,11 @@ const stringVisibleTrimSpacesRight = 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
+// 'soft' allows long words to expand past the column length.
 const exec = (string, columns, options = {}) => {
 	if (options.trim !== false && string.trim() === '') {
 		return '';
@@ -112,10 +114,10 @@ const exec = (string, columns, options = {}) => {
 
 	for (const [index, word] of string.split(' ').entries()) {
 		if (options.trim !== false) {
-			rows[rows.length - 1] = rows[rows.length - 1].trimStart();
+			rows[rows.length - 1] = rows.at(-1).trimStart();
 		}
 
-		let rowLength = stringWidth(rows[rows.length - 1]);
+		let rowLength = stringWidth(rows.at(-1));
 
 		if (index !== 0) {
 			if (rowLength >= columns && (options.wordWrap === false || options.trim === false)) {
@@ -164,13 +166,17 @@ const exec = (string, columns, options = {}) => {
 		rows = rows.map(row => stringVisibleTrimSpacesRight(row));
 	}
 
-	const pre = [...rows.join('\n')];
+	const preString = rows.join('\n');
+	const pre = [...preString];
+
+	// We need to keep a separate index as `String#slice()` works on Unicode code units, while `pre` is an array of codepoints.
+	let preStringIndex = 0;
 
 	for (const [index, character] of pre.entries()) {
 		returnValue += character;
 
 		if (ESCAPES.has(character)) {
-			const {groups} = new RegExp(`(?:\\${ANSI_CSI}(?<code>\\d+)m|\\${ANSI_ESCAPE_LINK}(?<uri>.*)${ANSI_ESCAPE_BELL})`).exec(pre.slice(index).join('')) || {groups: {}};
+			const {groups} = new RegExp(`(?:\\${ANSI_CSI}(?<code>\\d+)m|\\${ANSI_ESCAPE_LINK}(?<uri>.*)${ANSI_ESCAPE_BELL})`).exec(preString.slice(preStringIndex)) || {groups: {}};
 			if (groups.code !== undefined) {
 				const code = Number.parseFloat(groups.code);
 				escapeCode = code === END_CODE ? undefined : code;
@@ -198,6 +204,8 @@ const exec = (string, columns, options = {}) => {
 				returnValue += wrapAnsiHyperlink(escapeUrl);
 			}
 		}
+
+		preStringIndex += character.length;
 	}
 
 	return returnValue;
@@ -207,7 +215,7 @@ const exec = (string, columns, options = {}) => {
 export default function wrapAnsi(string, columns, options) {
 	return String(string)
 		.normalize()
-		.replace(/\r\n/g, '\n')
+		.replaceAll('\r\n', '\n')
 		.split('\n')
 		.map(line => exec(line, columns, options))
 		.join('\n');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrap-ansi",
-	"version": "8.0.1",
+	"version": "9.0.0",
 	"description": "Wordwrap a string with ANSI escape codes",
 	"license": "MIT",
 	"repository": "chalk/wrap-ansi",
@@ -11,15 +11,19 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
 	"engines": {
-		"node": ">=12"
+		"node": ">=18"
 	},
 	"scripts": {
-		"test": "xo && nyc ava"
+		"test": "xo && nyc ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"wrap",
@@ -49,16 +53,17 @@
 		"text"
 	],
 	"dependencies": {
-		"ansi-styles": "^6.1.0",
-		"string-width": "^5.0.1",
-		"strip-ansi": "^7.0.1"
+		"ansi-styles": "^6.2.1",
+		"string-width": "^7.0.0",
+		"strip-ansi": "^7.1.0"
 	},
 	"devDependencies": {
-		"ava": "^3.15.0",
-		"chalk": "^4.1.2",
+		"ava": "^5.3.1",
+		"chalk": "^5.3.0",
 		"coveralls": "^3.1.1",
 		"has-ansi": "^5.0.1",
 		"nyc": "^15.1.0",
-		"xo": "^0.44.0"
+		"tsd": "^0.29.0",
+		"xo": "^0.56.0"
 	}
 }

package/readme.md

@@ -4,8 +4,8 @@
 
 ## Install
 
-```
-$ npm install wrap-ansi
+```sh
+npm install wrap-ansi
 ```
 
 ## Usage
@@ -32,13 +32,15 @@ Wrap words to the specified column width.
 
 Type: `string`
 
-String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/chalk/chalk). Newline characters will be normalized to `\n`.
+A string with ANSI escape codes, like one styled by [`chalk`](https://github.com/chalk/chalk).
+
+Newline characters will be normalized to `\n`.
 
 #### columns
 
 Type: `number`
 
-Number of columns to wrap the text to.
+The number of columns to wrap the text to.
 
 #### options
 
@@ -71,21 +73,3 @@ Whitespace on all lines is removed by default. Set this option to `false` if you
 - [cli-truncate](https://github.com/sindresorhus/cli-truncate) - Truncate a string to a specific width in the terminal
 - [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)
-
----
-
-<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>