wrap-ansi 6.1.0 → 8.0.1

package/index.js

@@ -1,16 +1,21 @@
-'use strict';
-const stringWidth = require('string-width');
-const stripAnsi = require('strip-ansi');
-const ansiStyles = require('ansi-styles');
+import stringWidth from 'string-width';
+import stripAnsi from 'strip-ansi';
+import ansiStyles from 'ansi-styles';
 
 const ESCAPES = new Set([
 	'\u001B',
-	'\u009B'
+	'\u009B',
 ]);
 
 const END_CODE = 39;
+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}[${code}m`;
+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}`;
 
 // Calculate the length of words split on ' ', ignoring
 // the extra characters added by ansi escape codes
@@ -22,6 +27,7 @@ const wrapWord = (rows, word, columns) => {
 	const characters = [...word];
 
 	let isInsideEscape = false;
+	let isInsideLinkEscape = false;
 	let visible = stringWidth(stripAnsi(rows[rows.length - 1]));
 
 	for (const [index, character] of characters.entries()) {
@@ -36,12 +42,19 @@ const wrapWord = (rows, word, columns) => {
 
 		if (ESCAPES.has(character)) {
 			isInsideEscape = true;
-		} else if (isInsideEscape && character === 'm') {
-			isInsideEscape = false;
-			continue;
+			isInsideLinkEscape = characters.slice(index + 1).join('').startsWith(ANSI_ESCAPE_LINK);
 		}
 
 		if (isInsideEscape) {
+			if (isInsideLinkEscape) {
+				if (character === ANSI_ESCAPE_BELL) {
+					isInsideEscape = false;
+					isInsideLinkEscape = false;
+				}
+			} else if (character === ANSI_SGR_TERMINATOR) {
+				isInsideEscape = false;
+			}
+
 			continue;
 		}
 
@@ -61,8 +74,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,7 +87,7 @@ const stringVisibleTrimSpacesRight = str => {
 	}
 
 	if (last === words.length) {
-		return str;
+		return string;
 	}
 
 	return words.slice(0, last).join(' ') + words.slice(last).join('');
@@ -90,16 +103,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]);
@@ -148,39 +161,54 @@ const exec = (string, columns, options = {}) => {
 	}
 
 	if (options.trim !== false) {
-		rows = rows.map(stringVisibleTrimSpacesRight);
+		rows = rows.map(row => stringVisibleTrimSpacesRight(row));
 	}
 
-	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 += wrapAnsiCode(code);
+			}
+		} else if (character === '\n') {
+			if (escapeCode && code) {
+				returnValue += wrapAnsiCode(escapeCode);
+			}
+
+			if (escapeUrl) {
+				returnValue += wrapAnsiHyperlink(escapeUrl);
 			}
 		}
 	}
 
-	return ret;
+	return returnValue;
 };
 
 // For each newline, invoke the method separately
-module.exports = (string, columns, options) => {
+export default function wrapAnsi(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,19 @@
 {
 	"name": "wrap-ansi",
-	"version": "6.1.0",
+	"version": "8.0.1",
 	"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"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=8"
+		"node": ">=12"
 	},
 	"scripts": {
 		"test": "xo && nyc ava"
@@ -46,16 +49,16 @@
 		"text"
 	],
 	"dependencies": {
-		"ansi-styles": "^4.0.0",
-		"string-width": "^4.1.0",
-		"strip-ansi": "^5.0.0"
+		"ansi-styles": "^6.1.0",
+		"string-width": "^5.0.1",
+		"strip-ansi": "^7.0.1"
 	},
 	"devDependencies": {
-		"ava": "^2.1.0",
-		"chalk": "^2.4.2",
-		"coveralls": "^3.0.3",
-		"has-ansi": "^3.0.0",
-		"nyc": "^14.1.1",
-		"xo": "^0.24.0"
+		"ava": "^3.15.0",
+		"chalk": "^4.1.2",
+		"coveralls": "^3.1.1",
+		"has-ansi": "^5.0.1",
+		"nyc": "^15.1.0",
+		"xo": "^0.44.0"
 	}
 }

package/readme.md

@@ -1,20 +1,18 @@
-# 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
 
 > 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
-const chalk = require('chalk');
-const wrapAnsi = require('wrap-ansi');
+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.');
@@ -24,7 +22,6 @@ console.log(wrapAnsi(input, 20));
 
 <img width="331" src="screenshot.png">
 
-
 ## API
 
 ### wrapAnsi(string, columns, options?)
@@ -49,26 +46,25 @@ 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
@@ -76,14 +72,12 @@ 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)
 
-
 ---
 
 <div align="center">