@rushstack/terminal 0.5.38 → 0.7.0

package/dist/terminal.d.ts

@@ -318,10 +318,55 @@ export declare class PrintUtilities {
      */
     static getConsoleWidth(): number | undefined;
     /**
-     * Applies word wrapping.  If maxLineLength is unspecified, then it defaults to the
-     * console width.
+     * Applies word wrapping.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indent - The number of spaces to indent the wrapped lines, defaults to 0
      */
     static wrapWords(text: string, maxLineLength?: number, indent?: number): string;
+    /**
+     * Applies word wrapping.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param linePrefix - The string to prefix each line with, defaults to ''
+     */
+    static wrapWords(text: string, maxLineLength?: number, linePrefix?: string): string;
+    /**
+     * Applies word wrapping.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indentOrLinePrefix - The number of spaces to indent the wrapped lines or the string to prefix
+     * each line with, defaults to no prefix
+     */
+    static wrapWords(text: string, maxLineLength?: number, indentOrLinePrefix?: number | string): string;
+    /**
+     * Applies word wrapping and returns an array of lines.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indent - The number of spaces to indent the wrapped lines, defaults to 0
+     */
+    static wrapWordsToLines(text: string, maxLineLength?: number, indent?: number): string[];
+    /**
+     * Applies word wrapping and returns an array of lines.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param linePrefix - The string to prefix each line with, defaults to ''
+     */
+    static wrapWordsToLines(text: string, maxLineLength?: number, linePrefix?: string): string[];
+    /**
+     * Applies word wrapping and returns an array of lines.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indentOrLinePrefix - The number of spaces to indent the wrapped lines or the string to prefix
+     * each line with, defaults to no prefix
+     */
+    static wrapWordsToLines(text: string, maxLineLength?: number, indentOrLinePrefix?: number | string): string[];
     /**
      * Displays a message in the console wrapped in a box UI.
      *

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.36.4"
+      "packageVersion": "7.37.0"
     }
   ]
 }

package/lib/PrintUtilities.d.ts

@@ -16,10 +16,55 @@ export declare class PrintUtilities {
      */
     static getConsoleWidth(): number | undefined;
     /**
-     * Applies word wrapping.  If maxLineLength is unspecified, then it defaults to the
-     * console width.
+     * Applies word wrapping.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indent - The number of spaces to indent the wrapped lines, defaults to 0
      */
     static wrapWords(text: string, maxLineLength?: number, indent?: number): string;
+    /**
+     * Applies word wrapping.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param linePrefix - The string to prefix each line with, defaults to ''
+     */
+    static wrapWords(text: string, maxLineLength?: number, linePrefix?: string): string;
+    /**
+     * Applies word wrapping.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indentOrLinePrefix - The number of spaces to indent the wrapped lines or the string to prefix
+     * each line with, defaults to no prefix
+     */
+    static wrapWords(text: string, maxLineLength?: number, indentOrLinePrefix?: number | string): string;
+    /**
+     * Applies word wrapping and returns an array of lines.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indent - The number of spaces to indent the wrapped lines, defaults to 0
+     */
+    static wrapWordsToLines(text: string, maxLineLength?: number, indent?: number): string[];
+    /**
+     * Applies word wrapping and returns an array of lines.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param linePrefix - The string to prefix each line with, defaults to ''
+     */
+    static wrapWordsToLines(text: string, maxLineLength?: number, linePrefix?: string): string[];
+    /**
+     * Applies word wrapping and returns an array of lines.
+     *
+     * @param text - The text to wrap
+     * @param maxLineLength - The maximum length of a line, defaults to the console width
+     * @param indentOrLinePrefix - The number of spaces to indent the wrapped lines or the string to prefix
+     * each line with, defaults to no prefix
+     */
+    static wrapWordsToLines(text: string, maxLineLength?: number, indentOrLinePrefix?: number | string): string[];
     /**
      * Displays a message in the console wrapped in a box UI.
      *

package/lib/PrintUtilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PrintUtilities.d.ts","sourceRoot":"","sources":["../src/PrintUtilities.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAW,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,cAAc;IACzB;;OAEG;WACW,eAAe,IAAI,MAAM,GAAG,SAAS;IAOnD;;;OAGG;WACW,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IA0BtF;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;CAsB/F"}
+{"version":3,"file":"PrintUtilities.d.ts","sourceRoot":"","sources":["../src/PrintUtilities.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAW,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,cAAc;IACzB;;OAEG;WACW,eAAe,IAAI,MAAM,GAAG,SAAS;IAInD;;;;;;OAMG;WACW,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IACtF;;;;;;OAMG;WACW,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;IAC1F;;;;;;;OAOG;WACW,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAc3G;;;;;;OAMG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;IAC/F;;;;;;OAMG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;IACnG;;;;;;;OAOG;WACW,gBAAgB,CAC5B,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,MAAM,EACtB,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,GACnC,MAAM,EAAE;IA4EX;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;CAqB/F"}

package/lib/PrintUtilities.js

@@ -1,12 +1,8 @@
 "use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PrintUtilities = exports.DEFAULT_CONSOLE_WIDTH = void 0;
-const wordwrap_1 = __importDefault(require("wordwrap"));
 /**
  * A sensible fallback column width for consoles.
  *
@@ -23,35 +19,75 @@ class PrintUtilities {
      * Returns the width of the console, measured in columns
      */
     static getConsoleWidth() {
-        const stdout = process.stdout;
-        if (stdout && stdout.columns) {
-            return stdout.columns;
-        }
+        var _a;
+        return (_a = process.stdout) === null || _a === void 0 ? void 0 : _a.columns;
     }
-    /**
-     * Applies word wrapping.  If maxLineLength is unspecified, then it defaults to the
-     * console width.
-     */
-    static wrapWords(text, maxLineLength, indent) {
-        if (!indent) {
-            indent = 0;
+    static wrapWords(text, maxLineLength, indentOrLinePrefix) {
+        const wrappedLines = PrintUtilities.wrapWordsToLines(text, maxLineLength, indentOrLinePrefix // TS is confused by the overloads
+        );
+        return wrappedLines.join('\n');
+    }
+    static wrapWordsToLines(text, maxLineLength, indentOrLinePrefix) {
+        var _a;
+        let linePrefix;
+        switch (typeof indentOrLinePrefix) {
+            case 'number':
+                linePrefix = ' '.repeat(indentOrLinePrefix);
+                break;
+            case 'string':
+                linePrefix = indentOrLinePrefix;
+                break;
+            default:
+                linePrefix = '';
+                break;
         }
+        const linePrefixLength = linePrefix.length;
         if (!maxLineLength) {
             maxLineLength = PrintUtilities.getConsoleWidth() || exports.DEFAULT_CONSOLE_WIDTH;
         }
-        // Apply word wrapping and the provided indent, while also respecting existing newlines
+        // Apply word wrapping and the provided line prefix, while also respecting existing newlines
         // and prefix spaces that may exist in the text string already.
         const lines = text.split(/\r?\n/);
-        const wrappedLines = lines.map((line) => {
-            var _a;
-            const startingSpace = line.match(/^ +/);
-            const addlIndent = ((_a = startingSpace === null || startingSpace === void 0 ? void 0 : startingSpace[0]) === null || _a === void 0 ? void 0 : _a.length) || 0;
-            if (addlIndent > 0) {
-                line = line.replace(/^ +/, '');
+        const wrappedLines = [];
+        for (const line of lines) {
+            if (line.length + linePrefixLength <= maxLineLength) {
+                wrappedLines.push(linePrefix + line);
             }
-            return (0, wordwrap_1.default)(indent + addlIndent, maxLineLength - indent - addlIndent, { mode: 'soft' })(line);
-        });
-        return wrappedLines.join('\n');
+            else {
+                const lineAdditionalPrefix = ((_a = line.match(/^\s*/)) === null || _a === void 0 ? void 0 : _a[0]) || '';
+                const whitespaceRegexp = /\s+/g;
+                let currentWhitespaceMatch = null;
+                let previousWhitespaceMatch;
+                let currentLineStartIndex = lineAdditionalPrefix.length;
+                let previousBreakRanOver = false;
+                while ((currentWhitespaceMatch = whitespaceRegexp.exec(line)) !== null) {
+                    if (currentWhitespaceMatch.index + linePrefixLength - currentLineStartIndex > maxLineLength) {
+                        let whitespaceToSplitAt;
+                        if (!previousWhitespaceMatch ||
+                            // Handle the case where there are two words longer than the maxLineLength in a row
+                            previousBreakRanOver) {
+                            whitespaceToSplitAt = currentWhitespaceMatch;
+                        }
+                        else {
+                            whitespaceToSplitAt = previousWhitespaceMatch;
+                        }
+                        wrappedLines.push(linePrefix +
+                            lineAdditionalPrefix +
+                            line.substring(currentLineStartIndex, whitespaceToSplitAt.index));
+                        previousBreakRanOver = whitespaceToSplitAt.index - currentLineStartIndex > maxLineLength;
+                        currentLineStartIndex = whitespaceToSplitAt.index + whitespaceToSplitAt[0].length;
+                    }
+                    else {
+                        previousBreakRanOver = false;
+                    }
+                    previousWhitespaceMatch = currentWhitespaceMatch;
+                }
+                if (currentLineStartIndex < line.length) {
+                    wrappedLines.push(linePrefix + lineAdditionalPrefix + line.substring(currentLineStartIndex));
+                }
+            }
+        }
+        return wrappedLines;
     }
     /**
      * Displays a message in the console wrapped in a box UI.
@@ -64,8 +100,7 @@ class PrintUtilities {
             boxWidth = Math.floor(consoleWidth / 2);
         }
         const maxLineLength = boxWidth - 10;
-        const wrappedMessage = PrintUtilities.wrapWords(message, maxLineLength);
-        const wrappedMessageLines = wrappedMessage.split('\n');
+        const wrappedMessageLines = PrintUtilities.wrapWordsToLines(message, maxLineLength);
         // ╔═══════════╗
         // ║  Message  ║
         // ╚═══════════╝

package/lib/PrintUtilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"PrintUtilities.js","sourceRoot":"","sources":["../src/PrintUtilities.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAG3D,wDAAgC;AAGhC;;;;GAIG;AACU,QAAA,qBAAqB,GAAW,EAAE,CAAC;AAEhD;;;;GAIG;AACH,MAAa,cAAc;IACzB;;OAEG;IACI,MAAM,CAAC,eAAe;QAC3B,MAAM,MAAM,GAAoB,OAAO,CAAC,MAAyB,CAAC;QAClE,IAAI,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE;YAC5B,OAAO,MAAM,CAAC,OAAO,CAAC;SACvB;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,aAAsB,EAAE,MAAe;QAC3E,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,CAAC,CAAC;SACZ;QAED,IAAI,CAAC,aAAa,EAAE;YAClB,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;SAC3E;QAED,uFAAuF;QACvF,+DAA+D;QAC/D,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAa,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;;YAChD,MAAM,aAAa,GAA4B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACjE,MAAM,UAAU,GAAW,CAAA,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAG,CAAC,CAAC,0CAAE,MAAM,KAAI,CAAC,CAAC;YAE3D,IAAI,UAAU,GAAG,CAAC,EAAE;gBAClB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;aAChC;YAED,OAAO,IAAA,kBAAQ,EAAC,MAAO,GAAG,UAAU,EAAE,aAAc,GAAG,MAAO,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACvG,CAAC,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAmB,EAAE,QAAiB;QACrF,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,YAAY,GAAW,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;YACvF,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;SACzC;QACD,MAAM,aAAa,GAAW,QAAQ,GAAG,EAAE,CAAC;QAC5C,MAAM,cAAc,GAAW,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAChF,MAAM,mBAAmB,GAAa,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEjE,gBAAgB;QAChB,gBAAgB;QAChB,gBAAgB;QAChB,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE;YACtC,MAAM,WAAW,GAAW,IAAI,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,OAAO,GAAW,QAAQ,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YAC1D,MAAM,WAAW,GAAW,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YACpD,MAAM,YAAY,GAAW,OAAO,GAAG,WAAW,CAAC;YACnD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;SAC/F;QACD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;CACF;AApED,wCAoEC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as tty from 'tty';\nimport wordwrap from 'wordwrap';\nimport { ITerminal } from '@rushstack/node-core-library';\n\n/**\n * A sensible fallback column width for consoles.\n *\n * @public\n */\nexport const DEFAULT_CONSOLE_WIDTH: number = 80;\n\n/**\n * A collection of utilities for printing messages to the console.\n *\n * @public\n */\nexport class PrintUtilities {\n  /**\n   * Returns the width of the console, measured in columns\n   */\n  public static getConsoleWidth(): number | undefined {\n    const stdout: tty.WriteStream = process.stdout as tty.WriteStream;\n    if (stdout && stdout.columns) {\n      return stdout.columns;\n    }\n  }\n\n  /**\n   * Applies word wrapping.  If maxLineLength is unspecified, then it defaults to the\n   * console width.\n   */\n  public static wrapWords(text: string, maxLineLength?: number, indent?: number): string {\n    if (!indent) {\n      indent = 0;\n    }\n\n    if (!maxLineLength) {\n      maxLineLength = PrintUtilities.getConsoleWidth() || DEFAULT_CONSOLE_WIDTH;\n    }\n\n    // Apply word wrapping and the provided indent, while also respecting existing newlines\n    // and prefix spaces that may exist in the text string already.\n    const lines: string[] = text.split(/\\r?\\n/);\n    const wrappedLines: string[] = lines.map((line) => {\n      const startingSpace: RegExpMatchArray | null = line.match(/^ +/);\n      const addlIndent: number = startingSpace?.[0]?.length || 0;\n\n      if (addlIndent > 0) {\n        line = line.replace(/^ +/, '');\n      }\n\n      return wordwrap(indent! + addlIndent, maxLineLength! - indent! - addlIndent, { mode: 'soft' })(line);\n    });\n\n    return wrappedLines.join('\\n');\n  }\n\n  /**\n   * Displays a message in the console wrapped in a box UI.\n   *\n   * @param boxWidth - The width of the box, defaults to half of the console width.\n   */\n  public static printMessageInBox(message: string, terminal: ITerminal, boxWidth?: number): void {\n    if (!boxWidth) {\n      const consoleWidth: number = PrintUtilities.getConsoleWidth() || DEFAULT_CONSOLE_WIDTH;\n      boxWidth = Math.floor(consoleWidth / 2);\n    }\n    const maxLineLength: number = boxWidth - 10;\n    const wrappedMessage: string = PrintUtilities.wrapWords(message, maxLineLength);\n    const wrappedMessageLines: string[] = wrappedMessage.split('\\n');\n\n    // ╔═══════════╗\n    // ║  Message  ║\n    // ╚═══════════╝\n    terminal.writeLine(` ╔${'═'.repeat(boxWidth - 2)}╗ `);\n    for (const line of wrappedMessageLines) {\n      const trimmedLine: string = line.trim();\n      const padding: number = boxWidth - trimmedLine.length - 2;\n      const leftPadding: number = Math.floor(padding / 2);\n      const rightPadding: number = padding - leftPadding;\n      terminal.writeLine(` ║${' '.repeat(leftPadding)}${trimmedLine}${' '.repeat(rightPadding)}║ `);\n    }\n    terminal.writeLine(` ╚${'═'.repeat(boxWidth - 2)}╝ `);\n  }\n}\n"]}
+{"version":3,"file":"PrintUtilities.js","sourceRoot":"","sources":["../src/PrintUtilities.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D;;;;GAIG;AACU,QAAA,qBAAqB,GAAW,EAAE,CAAC;AAEhD;;;;GAIG;AACH,MAAa,cAAc;IACzB;;OAEG;IACI,MAAM,CAAC,eAAe;;QAC3B,OAAO,MAAA,OAAO,CAAC,MAAM,0CAAE,OAAO,CAAC;IACjC,CAAC;IA2BM,MAAM,CAAC,SAAS,CACrB,IAAY,EACZ,aAAsB,EACtB,kBAAoC;QAEpC,MAAM,YAAY,GAAa,cAAc,CAAC,gBAAgB,CAC5D,IAAI,EACJ,aAAa,EACb,kBAAwC,CAAC,kCAAkC;SAC5E,CAAC;QACF,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IA+BM,MAAM,CAAC,gBAAgB,CAC5B,IAAY,EACZ,aAAsB,EACtB,kBAAoC;;QAEpC,IAAI,UAAkB,CAAC;QACvB,QAAQ,OAAO,kBAAkB,EAAE;YACjC,KAAK,QAAQ;gBACX,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,QAAQ;gBACX,UAAU,GAAG,kBAAkB,CAAC;gBAChC,MAAM;YACR;gBACE,UAAU,GAAG,EAAE,CAAC;gBAChB,MAAM;SACT;QAED,MAAM,gBAAgB,GAAW,UAAU,CAAC,MAAM,CAAC;QAEnD,IAAI,CAAC,aAAa,EAAE;YAClB,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;SAC3E;QAED,4FAA4F;QAC5F,+DAA+D;QAC/D,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE5C,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,IAAI,CAAC,MAAM,GAAG,gBAAgB,IAAI,aAAa,EAAE;gBACnD,YAAY,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;aACtC;iBAAM;gBACL,MAAM,oBAAoB,GAAW,CAAA,MAAA,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,0CAAG,CAAC,CAAC,KAAI,EAAE,CAAC;gBACnE,MAAM,gBAAgB,GAAW,MAAM,CAAC;gBACxC,IAAI,sBAAsB,GAA2B,IAAI,CAAC;gBAC1D,IAAI,uBAAoD,CAAC;gBACzD,IAAI,qBAAqB,GAAW,oBAAoB,CAAC,MAAM,CAAC;gBAChE,IAAI,oBAAoB,GAAY,KAAK,CAAC;gBAC1C,OAAO,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;oBACtE,IAAI,sBAAsB,CAAC,KAAK,GAAG,gBAAgB,GAAG,qBAAqB,GAAG,aAAa,EAAE;wBAC3F,IAAI,mBAAgD,CAAC;wBACrD,IACE,CAAC,uBAAuB;4BACxB,mFAAmF;4BACnF,oBAAoB,EACpB;4BACA,mBAAmB,GAAG,sBAAsB,CAAC;yBAC9C;6BAAM;4BACL,mBAAmB,GAAG,uBAAuB,CAAC;yBAC/C;wBAED,YAAY,CAAC,IAAI,CACf,UAAU;4BACR,oBAAoB;4BACpB,IAAI,CAAC,SAAS,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,KAAK,CAAC,CACnE,CAAC;wBACF,oBAAoB,GAAG,mBAAmB,CAAC,KAAK,GAAG,qBAAqB,GAAG,aAAa,CAAC;wBACzF,qBAAqB,GAAG,mBAAmB,CAAC,KAAK,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;qBACnF;yBAAM;wBACL,oBAAoB,GAAG,KAAK,CAAC;qBAC9B;oBAED,uBAAuB,GAAG,sBAAsB,CAAC;iBAClD;gBAED,IAAI,qBAAqB,GAAG,IAAI,CAAC,MAAM,EAAE;oBACvC,YAAY,CAAC,IAAI,CAAC,UAAU,GAAG,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,CAAC;iBAC9F;aACF;SACF;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAmB,EAAE,QAAiB;QACrF,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,YAAY,GAAW,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;YACvF,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;SACzC;QACD,MAAM,aAAa,GAAW,QAAQ,GAAG,EAAE,CAAC;QAC5C,MAAM,mBAAmB,GAAa,cAAc,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAE9F,gBAAgB;QAChB,gBAAgB;QAChB,gBAAgB;QAChB,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE;YACtC,MAAM,WAAW,GAAW,IAAI,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,OAAO,GAAW,QAAQ,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YAC1D,MAAM,WAAW,GAAW,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YACpD,MAAM,YAAY,GAAW,OAAO,GAAG,WAAW,CAAC;YACnD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;SAC/F;QACD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;CACF;AAhLD,wCAgLC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { ITerminal } from '@rushstack/node-core-library';\n\n/**\n * A sensible fallback column width for consoles.\n *\n * @public\n */\nexport const DEFAULT_CONSOLE_WIDTH: number = 80;\n\n/**\n * A collection of utilities for printing messages to the console.\n *\n * @public\n */\nexport class PrintUtilities {\n  /**\n   * Returns the width of the console, measured in columns\n   */\n  public static getConsoleWidth(): number | undefined {\n    return process.stdout?.columns;\n  }\n\n  /**\n   * Applies word wrapping.\n   *\n   * @param text - The text to wrap\n   * @param maxLineLength - The maximum length of a line, defaults to the console width\n   * @param indent - The number of spaces to indent the wrapped lines, defaults to 0\n   */\n  public static wrapWords(text: string, maxLineLength?: number, indent?: number): string;\n  /**\n   * Applies word wrapping.\n   *\n   * @param text - The text to wrap\n   * @param maxLineLength - The maximum length of a line, defaults to the console width\n   * @param linePrefix - The string to prefix each line with, defaults to ''\n   */\n  public static wrapWords(text: string, maxLineLength?: number, linePrefix?: string): string;\n  /**\n   * Applies word wrapping.\n   *\n   * @param text - The text to wrap\n   * @param maxLineLength - The maximum length of a line, defaults to the console width\n   * @param indentOrLinePrefix - The number of spaces to indent the wrapped lines or the string to prefix\n   * each line with, defaults to no prefix\n   */\n  public static wrapWords(text: string, maxLineLength?: number, indentOrLinePrefix?: number | string): string;\n  public static wrapWords(\n    text: string,\n    maxLineLength?: number,\n    indentOrLinePrefix?: number | string\n  ): string {\n    const wrappedLines: string[] = PrintUtilities.wrapWordsToLines(\n      text,\n      maxLineLength,\n      indentOrLinePrefix as string | undefined // TS is confused by the overloads\n    );\n    return wrappedLines.join('\\n');\n  }\n\n  /**\n   * Applies word wrapping and returns an array of lines.\n   *\n   * @param text - The text to wrap\n   * @param maxLineLength - The maximum length of a line, defaults to the console width\n   * @param indent - The number of spaces to indent the wrapped lines, defaults to 0\n   */\n  public static wrapWordsToLines(text: string, maxLineLength?: number, indent?: number): string[];\n  /**\n   * Applies word wrapping and returns an array of lines.\n   *\n   * @param text - The text to wrap\n   * @param maxLineLength - The maximum length of a line, defaults to the console width\n   * @param linePrefix - The string to prefix each line with, defaults to ''\n   */\n  public static wrapWordsToLines(text: string, maxLineLength?: number, linePrefix?: string): string[];\n  /**\n   * Applies word wrapping and returns an array of lines.\n   *\n   * @param text - The text to wrap\n   * @param maxLineLength - The maximum length of a line, defaults to the console width\n   * @param indentOrLinePrefix - The number of spaces to indent the wrapped lines or the string to prefix\n   * each line with, defaults to no prefix\n   */\n  public static wrapWordsToLines(\n    text: string,\n    maxLineLength?: number,\n    indentOrLinePrefix?: number | string\n  ): string[];\n  public static wrapWordsToLines(\n    text: string,\n    maxLineLength?: number,\n    indentOrLinePrefix?: number | string\n  ): string[] {\n    let linePrefix: string;\n    switch (typeof indentOrLinePrefix) {\n      case 'number':\n        linePrefix = ' '.repeat(indentOrLinePrefix);\n        break;\n      case 'string':\n        linePrefix = indentOrLinePrefix;\n        break;\n      default:\n        linePrefix = '';\n        break;\n    }\n\n    const linePrefixLength: number = linePrefix.length;\n\n    if (!maxLineLength) {\n      maxLineLength = PrintUtilities.getConsoleWidth() || DEFAULT_CONSOLE_WIDTH;\n    }\n\n    // Apply word wrapping and the provided line prefix, while also respecting existing newlines\n    // and prefix spaces that may exist in the text string already.\n    const lines: string[] = text.split(/\\r?\\n/);\n\n    const wrappedLines: string[] = [];\n    for (const line of lines) {\n      if (line.length + linePrefixLength <= maxLineLength) {\n        wrappedLines.push(linePrefix + line);\n      } else {\n        const lineAdditionalPrefix: string = line.match(/^\\s*/)?.[0] || '';\n        const whitespaceRegexp: RegExp = /\\s+/g;\n        let currentWhitespaceMatch: RegExpExecArray | null = null;\n        let previousWhitespaceMatch: RegExpExecArray | undefined;\n        let currentLineStartIndex: number = lineAdditionalPrefix.length;\n        let previousBreakRanOver: boolean = false;\n        while ((currentWhitespaceMatch = whitespaceRegexp.exec(line)) !== null) {\n          if (currentWhitespaceMatch.index + linePrefixLength - currentLineStartIndex > maxLineLength) {\n            let whitespaceToSplitAt: RegExpExecArray | undefined;\n            if (\n              !previousWhitespaceMatch ||\n              // Handle the case where there are two words longer than the maxLineLength in a row\n              previousBreakRanOver\n            ) {\n              whitespaceToSplitAt = currentWhitespaceMatch;\n            } else {\n              whitespaceToSplitAt = previousWhitespaceMatch;\n            }\n\n            wrappedLines.push(\n              linePrefix +\n                lineAdditionalPrefix +\n                line.substring(currentLineStartIndex, whitespaceToSplitAt.index)\n            );\n            previousBreakRanOver = whitespaceToSplitAt.index - currentLineStartIndex > maxLineLength;\n            currentLineStartIndex = whitespaceToSplitAt.index + whitespaceToSplitAt[0].length;\n          } else {\n            previousBreakRanOver = false;\n          }\n\n          previousWhitespaceMatch = currentWhitespaceMatch;\n        }\n\n        if (currentLineStartIndex < line.length) {\n          wrappedLines.push(linePrefix + lineAdditionalPrefix + line.substring(currentLineStartIndex));\n        }\n      }\n    }\n\n    return wrappedLines;\n  }\n\n  /**\n   * Displays a message in the console wrapped in a box UI.\n   *\n   * @param boxWidth - The width of the box, defaults to half of the console width.\n   */\n  public static printMessageInBox(message: string, terminal: ITerminal, boxWidth?: number): void {\n    if (!boxWidth) {\n      const consoleWidth: number = PrintUtilities.getConsoleWidth() || DEFAULT_CONSOLE_WIDTH;\n      boxWidth = Math.floor(consoleWidth / 2);\n    }\n    const maxLineLength: number = boxWidth - 10;\n    const wrappedMessageLines: string[] = PrintUtilities.wrapWordsToLines(message, maxLineLength);\n\n    // ╔═══════════╗\n    // ║  Message  ║\n    // ╚═══════════╝\n    terminal.writeLine(` ╔${'═'.repeat(boxWidth - 2)}╗ `);\n    for (const line of wrappedMessageLines) {\n      const trimmedLine: string = line.trim();\n      const padding: number = boxWidth - trimmedLine.length - 2;\n      const leftPadding: number = Math.floor(padding / 2);\n      const rightPadding: number = padding - leftPadding;\n      terminal.writeLine(` ║${' '.repeat(leftPadding)}${trimmedLine}${' '.repeat(rightPadding)}║ `);\n    }\n    terminal.writeLine(` ╚${'═'.repeat(boxWidth - 2)}╝ `);\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/terminal",
-  "version": "0.5.38",
+  "version": "0.7.0",
   "description": "User interface primitives for console applications",
   "main": "lib/index.js",
   "typings": "dist/terminal.d.ts",
@@ -11,17 +11,15 @@
     "directory": "libraries/terminal"
   },
   "dependencies": {
-    "wordwrap": "~1.0.0",
-    "@rushstack/node-core-library": "3.59.7"
+    "@rushstack/node-core-library": "3.60.0"
   },
   "devDependencies": {
     "@types/heft-jest": "1.0.1",
-    "@types/node": "14.18.36",
-    "@types/wordwrap": "~1.0.0",
+    "@types/node": "18.17.15",
     "colors": "~1.2.1",
-    "@rushstack/eslint-config": "3.3.3",
-    "@rushstack/heft": "0.58.2",
-    "@rushstack/heft-node-rig": "2.2.22"
+    "@rushstack/eslint-config": "3.3.4",
+    "@rushstack/heft": "0.59.0",
+    "@rushstack/heft-node-rig": "2.2.23"
   },
   "peerDependencies": {
     "@types/node": "*"