Support hyperlinks in supported terminals

index.js

@@ -10,6 +10,9 @@ const ESCAPES = new Set([
 
 const END_CODE = 39;
 
+const ANSI_ESCAPE_BELL = '\u0007';
+const ANSI_ESCAPE_LINK = ']8;;';
+
 const wrapAnsi = code => `${ESCAPES.values().next().value}[${code}m`;
 
 // Calculate the length of words split on ' ', ignoring
@@ -22,6 +25,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 +40,20 @@ const wrapWord = (rows, word, columns) => {
 
 		if (ESCAPES.has(character)) {
 			isInsideEscape = true;
-		} else if (isInsideEscape && character === 'm') {
-			isInsideEscape = false;
-			continue;
+			isInsideLinkEscape = word.slice(index).startsWith(`${character}${ANSI_ESCAPE_LINK}`);
 		}
 
 		if (isInsideEscape) {
+			/* istanbul ignore if: cannot enter on terminals not supporting hyperlinks */
+			if (isInsideLinkEscape) {
+				if (character === ANSI_ESCAPE_BELL) {
+					isInsideEscape = false;
+					isInsideLinkEscape = false;
+				}
+			} else if (character === 'm') {
+				isInsideEscape = false;
+			}
+
 			continue;
 		}
 

package.json

@@ -56,6 +56,7 @@
 		"coveralls": "^3.0.3",
 		"has-ansi": "^3.0.0",
 		"nyc": "^14.1.1",
+		"terminal-link": "^2.0.0",
 		"xo": "^0.24.0"
 	}
 }

test.js

@@ -2,6 +2,7 @@ import test from 'ava';
 import chalk from 'chalk';
 import hasAnsi from 'has-ansi';
 import stripAnsi from 'strip-ansi';
+import terminalLink from 'terminal-link';
 import wrapAnsi from '.';
 
 chalk.enabled = true;
@@ -148,3 +149,21 @@ test('#27, does not remove spaces in line with ansi escapes when no trimming', t
 	t.is(wrapAnsi(chalk.bgGreen(`  ${chalk.black('OK')} `), 100, {trim: false}), chalk.bgGreen(`  ${chalk.black('OK')} `));
 	t.is(wrapAnsi(chalk.bgGreen(' hello '), 10, {hard: true, trim: false}), chalk.bgGreen(' hello '));
 });
+
+test('#35, wraps hyperlinks, preserving clickability in supporting terminals', t => {
+	const link = 'https://testlogin:testpassword@areallylongurlthatneedstogetwrapped.com/with_some/path?andparams=bogus&more=evenmorebogus#evensomehashparams=notdoinganything';
+	const input = `hi http://js.io ${terminalLink(link, link, {fallback: text => text})}`;
+	const expected = terminalLink.isSupported	?
+		'hi http://js.io\n\u001B]8;;https://testlogin:testpassword@areallylongurlthatneedstogetwrapped.com/with_some/path?andparams=bogus&more=evenmorebogus#evensomehashparams=notdoinganything\u0007https://testlogi\u001B[28m\n\u001B[8mn:testpassword@a\u001B[28m\n\u001B[8mreallylongurltha\u001B[28m\n\u001B[8mtneedstogetwrapp\u001B[28m\n\u001B[8med.com/with_some\u001B[28m\n\u001B[8m/path?andparams=\u001B[28m\n\u001B[8mbogus&more=evenm\u001B[28m\n\u001B[8morebogus#evensom\u001B[28m\n\u001B[8mehashparams=notd\u001B[28m\n\u001B[8moinganything\u001B]8;;\u0007' :
+		'hi http://js.io\nhttps://testlogi\nn:testpassword@a\nreallylongurltha\ntneedstogetwrapp\ned.com/with_some\n/path?andparams=\nbogus&more=evenm\norebogus#evensom\nehashparams=notd\noinganything';
+	t.is(wrapAnsi(input, 16, {hard: true}), expected);
+});
+
+test('#35, wraps coloured hyperlinks, preserving clickability in supporting terminals', t => {
+	const link = 'https://testlogin:testpassword@areallylongurlthatneedstogetwrapped.com/with_some/path?andparams=bogus&more=evenmorebogus#evensomehashparams=notdoinganything';
+	const input = `hi http://js.io ${terminalLink(chalk.bgGreen(link), link, {fallback: text => text})}`;
+	const expected = terminalLink.isSupported	?
+		`hi http://js.io\n\u001B]8;;https://testlogin:testpassword@areallylongurlthatneedstogetwrapped.com/with_some/path?andparams=bogus&more=evenmorebogus#evensomehashparams=notdoinganything\u0007${chalk.bgGreen('https://testlogi\nn:testpassword@a\nreallylongurltha\ntneedstogetwrapp\ned.com/with_some\n/path?andparams=\nbogus&more=evenm\norebogus#evensom\nehashparams=notd\noinganything')}\u001B]8;;\u0007` :
+		`hi http://js.io\n${chalk.bgGreen('https://testlogi\nn:testpassword@a\nreallylongurltha\ntneedstogetwrapp\ned.com/with_some\n/path?andparams=\nbogus&more=evenm\norebogus#evensom\nehashparams=notd\noinganything')}`;
+	t.is(wrapAnsi(input, 16, {hard: true}), expected);
+});