123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217 |
- 'use strict';
- const stringWidth = require('string-width');
- const stripAnsi = require('strip-ansi');
- const ansiStyles = require('ansi-styles');
- const ESCAPES = new Set([
- '\u001B',
- '\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}${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
- const wordLengths = string => string.split(' ').map(character => stringWidth(character));
- // Wrap a long word across multiple rows
- // Ansi escape codes do not count towards length
- 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()) {
- const characterLength = stringWidth(character);
- if (visible + characterLength <= columns) {
- rows[rows.length - 1] += character;
- } else {
- rows.push(character);
- visible = 0;
- }
- if (ESCAPES.has(character)) {
- isInsideEscape = true;
- 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;
- }
- visible += characterLength;
- if (visible === columns && index < characters.length - 1) {
- rows.push('');
- visible = 0;
- }
- }
- // 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) {
- rows[rows.length - 2] += rows.pop();
- }
- };
- // Trims spaces from a string ignoring invisible sequences
- const stringVisibleTrimSpacesRight = string => {
- const words = string.split(' ');
- let last = words.length;
- while (last > 0) {
- if (stringWidth(words[last - 1]) > 0) {
- break;
- }
- last--;
- }
- if (last === words.length) {
- 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
- //
- // '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 = {}) => {
- if (options.trim !== false && string.trim() === '') {
- return '';
- }
- 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].trimStart();
- }
- let rowLength = stringWidth(rows[rows.length - 1]);
- if (index !== 0) {
- 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;
- }
- 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'
- if (options.hard && lengths[index] > columns) {
- const remainingColumns = (columns - rowLength);
- const breaksStartingThisLine = 1 + Math.floor((lengths[index] - remainingColumns - 1) / columns);
- const breaksStartingNextLine = Math.floor((lengths[index] - 1) / columns);
- if (breaksStartingNextLine < breaksStartingThisLine) {
- rows.push('');
- }
- wrapWord(rows, word, columns);
- continue;
- }
- if (rowLength + lengths[index] > columns && rowLength > 0 && lengths[index] > 0) {
- if (options.wordWrap === false && rowLength < columns) {
- wrapWord(rows, word, columns);
- continue;
- }
- rows.push('');
- }
- if (rowLength + lengths[index] > columns && options.wordWrap === false) {
- wrapWord(rows, word, columns);
- continue;
- }
- rows[rows.length - 1] += word;
- }
- if (options.trim !== false) {
- rows = rows.map(stringVisibleTrimSpacesRight);
- }
- const pre = [...rows.join('\n')];
- 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: {}};
- 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 (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 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');
- };
|