@rushstack/terminal 0.7.24 → 0.8.0

package/lib/ITerminalProvider.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Similar to many popular logging packages, terminal providers support a range of message
+ * severities. These severities have built-in formatting defaults in the Terminal object
+ * (warnings are yellow, errors are red, etc.).
+ *
+ * Terminal providers may choose to suppress certain messages based on their severity,
+ * or to route some messages to other providers or not based on severity.
+ *
+ *   Severity  | Purpose
+ *   --------- | -------
+ *   error     | Build errors and fatal issues
+ *   warning   | Not necessarily fatal, but indicate a problem the user should fix
+ *   log       | Informational messages
+ *   verbose   | Additional information that may not always be necessary
+ *   debug     | Highest detail level, best used for troubleshooting information
+ *
+ * @beta
+ */
+export declare enum TerminalProviderSeverity {
+    log = 0,
+    warning = 1,
+    error = 2,
+    verbose = 3,
+    debug = 4
+}
+/**
+ * Implement the interface to create a terminal provider. Terminal providers
+ * can be registered to a {@link Terminal} instance to receive messages.
+ *
+ * @beta
+ */
+export interface ITerminalProvider {
+    /**
+     * This property should return true only if the terminal provider supports
+     * rendering console colors.
+     */
+    supportsColor: boolean;
+    /**
+     * This property should return the newline character the terminal provider
+     * expects.
+     */
+    eolCharacter: string;
+    /**
+     * This function gets called on every terminal provider upon every
+     * message function call on the terminal instance.
+     *
+     * @param data - The terminal message.
+     * @param severity - The message severity. Terminal providers can
+     * route different kinds of messages to different streams and may choose
+     * to ignore verbose or debug messages.
+     */
+    write(data: string, severity: TerminalProviderSeverity): void;
+}
+//# sourceMappingURL=ITerminalProvider.d.ts.map

package/lib/ITerminalProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITerminalProvider.d.ts","sourceRoot":"","sources":["../src/ITerminalProvider.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;GAiBG;AACH,oBAAY,wBAAwB;IAClC,GAAG,IAAA;IACH,OAAO,IAAA;IACP,KAAK,IAAA;IACL,OAAO,IAAA;IACP,KAAK,IAAA;CACN;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,wBAAwB,GAAG,IAAI,CAAC;CAC/D"}

package/lib/ITerminalProvider.js

@@ -0,0 +1,32 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TerminalProviderSeverity = void 0;
+/**
+ * Similar to many popular logging packages, terminal providers support a range of message
+ * severities. These severities have built-in formatting defaults in the Terminal object
+ * (warnings are yellow, errors are red, etc.).
+ *
+ * Terminal providers may choose to suppress certain messages based on their severity,
+ * or to route some messages to other providers or not based on severity.
+ *
+ *   Severity  | Purpose
+ *   --------- | -------
+ *   error     | Build errors and fatal issues
+ *   warning   | Not necessarily fatal, but indicate a problem the user should fix
+ *   log       | Informational messages
+ *   verbose   | Additional information that may not always be necessary
+ *   debug     | Highest detail level, best used for troubleshooting information
+ *
+ * @beta
+ */
+var TerminalProviderSeverity;
+(function (TerminalProviderSeverity) {
+    TerminalProviderSeverity[TerminalProviderSeverity["log"] = 0] = "log";
+    TerminalProviderSeverity[TerminalProviderSeverity["warning"] = 1] = "warning";
+    TerminalProviderSeverity[TerminalProviderSeverity["error"] = 2] = "error";
+    TerminalProviderSeverity[TerminalProviderSeverity["verbose"] = 3] = "verbose";
+    TerminalProviderSeverity[TerminalProviderSeverity["debug"] = 4] = "debug";
+})(TerminalProviderSeverity || (exports.TerminalProviderSeverity = TerminalProviderSeverity = {}));
+//# sourceMappingURL=ITerminalProvider.js.map

package/lib/ITerminalProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITerminalProvider.js","sourceRoot":"","sources":["../src/ITerminalProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D;;;;;;;;;;;;;;;;;GAiBG;AACH,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,qEAAG,CAAA;IACH,6EAAO,CAAA;IACP,yEAAK,CAAA;IACL,6EAAO,CAAA;IACP,yEAAK,CAAA;AACP,CAAC,EANW,wBAAwB,wCAAxB,wBAAwB,QAMnC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Similar to many popular logging packages, terminal providers support a range of message\n * severities. These severities have built-in formatting defaults in the Terminal object\n * (warnings are yellow, errors are red, etc.).\n *\n * Terminal providers may choose to suppress certain messages based on their severity,\n * or to route some messages to other providers or not based on severity.\n *\n *   Severity  | Purpose\n *   --------- | -------\n *   error     | Build errors and fatal issues\n *   warning   | Not necessarily fatal, but indicate a problem the user should fix\n *   log       | Informational messages\n *   verbose   | Additional information that may not always be necessary\n *   debug     | Highest detail level, best used for troubleshooting information\n *\n * @beta\n */\nexport enum TerminalProviderSeverity {\n  log,\n  warning,\n  error,\n  verbose,\n  debug\n}\n\n/**\n * Implement the interface to create a terminal provider. Terminal providers\n * can be registered to a {@link Terminal} instance to receive messages.\n *\n * @beta\n */\nexport interface ITerminalProvider {\n  /**\n   * This property should return true only if the terminal provider supports\n   * rendering console colors.\n   */\n  supportsColor: boolean;\n\n  /**\n   * This property should return the newline character the terminal provider\n   * expects.\n   */\n  eolCharacter: string;\n\n  /**\n   * This function gets called on every terminal provider upon every\n   * message function call on the terminal instance.\n   *\n   * @param data - The terminal message.\n   * @param severity - The message severity. Terminal providers can\n   * route different kinds of messages to different streams and may choose\n   * to ignore verbose or debug messages.\n   */\n  write(data: string, severity: TerminalProviderSeverity): void;\n}\n"]}

package/lib/MockWritable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MockWritable.d.ts","sourceRoot":"","sources":["../src/MockWritable.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,SAAgB,MAAM,EAAE,cAAc,EAAE,CAAM;IAE9C,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAI5C,KAAK,IAAI,IAAI;IAIb,YAAY,IAAI,MAAM;IAItB,kBAAkB,IAAI,cAAc,EAAE;CAG9C"}
+{"version":3,"file":"MockWritable.d.ts","sourceRoot":"","sources":["../src/MockWritable.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,SAAgB,MAAM,EAAE,cAAc,EAAE,CAAM;IAE9C,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAI5C,KAAK,IAAI,IAAI;IAIb,YAAY,IAAI,MAAM;IAItB,kBAAkB,IAAI,cAAc,EAAE;CAG9C"}

package/lib/MockWritable.js

@@ -3,8 +3,8 @@
 // See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MockWritable = void 0;
+const AnsiEscape_1 = require("./AnsiEscape");
 const TerminalWritable_1 = require("./TerminalWritable");
-const node_core_library_1 = require("@rushstack/node-core-library");
 /**
  * A {@link TerminalWritable} subclass for use by unit tests.
  *
@@ -22,10 +22,10 @@ class MockWritable extends TerminalWritable_1.TerminalWritable {
         this.chunks.length = 0;
     }
     getAllOutput() {
-        return node_core_library_1.AnsiEscape.formatForTests(this.chunks.map((x) => x.text).join(''));
+        return AnsiEscape_1.AnsiEscape.formatForTests(this.chunks.map((x) => x.text).join(''));
     }
     getFormattedChunks() {
-        return this.chunks.map((x) => (Object.assign(Object.assign({}, x), { text: node_core_library_1.AnsiEscape.formatForTests(x.text) })));
+        return this.chunks.map((x) => (Object.assign(Object.assign({}, x), { text: AnsiEscape_1.AnsiEscape.formatForTests(x.text) })));
     }
 }
 exports.MockWritable = MockWritable;

package/lib/MockWritable.js.map

@@ -1 +1 @@
-{"version":3,"file":"MockWritable.js","sourceRoot":"","sources":["../src/MockWritable.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,yDAAsD;AACtD,oEAA0D;AAE1D;;;;GAIG;AACH,MAAa,YAAa,SAAQ,mCAAgB;IAAlD;;QACkB,WAAM,GAAqB,EAAE,CAAC;IAiBhD,CAAC;IAfW,YAAY,CAAC,KAAqB;QAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IACzB,CAAC;IAEM,YAAY;QACjB,OAAO,8BAAU,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gCAAK,CAAC,KAAE,IAAI,EAAE,8BAAU,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAqB,CAAA,CAAC,CAAC;IACvG,CAAC;CACF;AAlBD,oCAkBC","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 type { ITerminalChunk } from './ITerminalChunk';\nimport { TerminalWritable } from './TerminalWritable';\nimport { AnsiEscape } from '@rushstack/node-core-library';\n\n/**\n * A {@link TerminalWritable} subclass for use by unit tests.\n *\n * @beta\n */\nexport class MockWritable extends TerminalWritable {\n  public readonly chunks: ITerminalChunk[] = [];\n\n  protected onWriteChunk(chunk: ITerminalChunk): void {\n    this.chunks.push(chunk);\n  }\n\n  public reset(): void {\n    this.chunks.length = 0;\n  }\n\n  public getAllOutput(): string {\n    return AnsiEscape.formatForTests(this.chunks.map((x) => x.text).join(''));\n  }\n\n  public getFormattedChunks(): ITerminalChunk[] {\n    return this.chunks.map((x) => ({ ...x, text: AnsiEscape.formatForTests(x.text) } as ITerminalChunk));\n  }\n}\n"]}
+{"version":3,"file":"MockWritable.js","sourceRoot":"","sources":["../src/MockWritable.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,6CAA0C;AAE1C,yDAAsD;AAEtD;;;;GAIG;AACH,MAAa,YAAa,SAAQ,mCAAgB;IAAlD;;QACkB,WAAM,GAAqB,EAAE,CAAC;IAiBhD,CAAC;IAfW,YAAY,CAAC,KAAqB;QAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IACzB,CAAC;IAEM,YAAY;QACjB,OAAO,uBAAU,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gCAAK,CAAC,KAAE,IAAI,EAAE,uBAAU,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAqB,CAAA,CAAC,CAAC;IACvG,CAAC;CACF;AAlBD,oCAkBC","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 { AnsiEscape } from './AnsiEscape';\nimport type { ITerminalChunk } from './ITerminalChunk';\nimport { TerminalWritable } from './TerminalWritable';\n\n/**\n * A {@link TerminalWritable} subclass for use by unit tests.\n *\n * @beta\n */\nexport class MockWritable extends TerminalWritable {\n  public readonly chunks: ITerminalChunk[] = [];\n\n  protected onWriteChunk(chunk: ITerminalChunk): void {\n    this.chunks.push(chunk);\n  }\n\n  public reset(): void {\n    this.chunks.length = 0;\n  }\n\n  public getAllOutput(): string {\n    return AnsiEscape.formatForTests(this.chunks.map((x) => x.text).join(''));\n  }\n\n  public getFormattedChunks(): ITerminalChunk[] {\n    return this.chunks.map((x) => ({ ...x, text: AnsiEscape.formatForTests(x.text) } as ITerminalChunk));\n  }\n}\n"]}

package/lib/PrefixProxyTerminalProvider.d.ts

@@ -0,0 +1,57 @@
+import type { ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';
+/**
+ * @beta
+ */
+export interface IPrefixProxyTerminalProviderOptionsBase {
+    /**
+     * The {@link ITerminalProvider} that will be wrapped.
+     */
+    terminalProvider: ITerminalProvider;
+}
+/**
+ * Options for {@link PrefixProxyTerminalProvider}, with a static prefix.
+ *
+ * @beta
+ */
+export interface IStaticPrefixProxyTerminalProviderOptions extends IPrefixProxyTerminalProviderOptionsBase {
+    /**
+     * The prefix that should be added to each line of output.
+     */
+    prefix: string;
+}
+/**
+ * Options for {@link PrefixProxyTerminalProvider}.
+ *
+ * @beta
+ */
+export interface IDynamicPrefixProxyTerminalProviderOptions extends IPrefixProxyTerminalProviderOptionsBase {
+    /**
+     * A function that returns the prefix that should be added to each line of output. This is useful
+     * for prefixing each line with a timestamp.
+     */
+    getPrefix: () => string;
+}
+/**
+ * @beta
+ */
+export type IPrefixProxyTerminalProviderOptions = IStaticPrefixProxyTerminalProviderOptions | IDynamicPrefixProxyTerminalProviderOptions;
+/**
+ * Wraps an existing {@link ITerminalProvider} that prefixes each line of output with a specified
+ * prefix string.
+ *
+ * @beta
+ */
+export declare class PrefixProxyTerminalProvider implements ITerminalProvider {
+    private readonly _parentTerminalProvider;
+    private readonly _getPrefix;
+    private readonly _newlineRegex;
+    private _isOnNewline;
+    constructor(options: IPrefixProxyTerminalProviderOptions);
+    /** @override */
+    get supportsColor(): boolean;
+    /** @override */
+    get eolCharacter(): string;
+    /** @override */
+    write(data: string, severity: TerminalProviderSeverity): void;
+}
+//# sourceMappingURL=PrefixProxyTerminalProvider.d.ts.map

package/lib/PrefixProxyTerminalProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrefixProxyTerminalProvider.d.ts","sourceRoot":"","sources":["../src/PrefixProxyTerminalProvider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,yCAA0C,SAAQ,uCAAuC;IACxG;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,0CAA2C,SAAQ,uCAAuC;IACzG;;;OAGG;IACH,SAAS,EAAE,MAAM,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,yCAAyC,GACzC,0CAA0C,CAAC;AAE/C;;;;;GAKG;AACH,qBAAa,2BAA4B,YAAW,iBAAiB;IACnE,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAoB;IAC5D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAC1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,YAAY,CAAU;gBAEX,OAAO,EAAE,mCAAmC;IAmB/D,gBAAgB;IAChB,IAAW,aAAa,IAAI,OAAO,CAElC;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,gBAAgB;IACT,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,wBAAwB,GAAG,IAAI;CA0BrE"}

package/lib/PrefixProxyTerminalProvider.js

@@ -0,0 +1,64 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrefixProxyTerminalProvider = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+/**
+ * Wraps an existing {@link ITerminalProvider} that prefixes each line of output with a specified
+ * prefix string.
+ *
+ * @beta
+ */
+class PrefixProxyTerminalProvider {
+    constructor(options) {
+        const { terminalProvider } = options;
+        this._parentTerminalProvider = terminalProvider;
+        if (options.prefix !== undefined) {
+            const { prefix } = options;
+            this._getPrefix = () => prefix;
+        }
+        else {
+            const { getPrefix } = options;
+            this._getPrefix = getPrefix;
+        }
+        this._isOnNewline = true;
+        // eslint-disable-next-line @rushstack/security/no-unsafe-regexp
+        this._newlineRegex = new RegExp(`${node_core_library_1.Text.escapeRegExp(terminalProvider.eolCharacter)}|\\n`, 'g');
+    }
+    /** @override */
+    get supportsColor() {
+        return this._parentTerminalProvider.supportsColor;
+    }
+    /** @override */
+    get eolCharacter() {
+        return this._parentTerminalProvider.eolCharacter;
+    }
+    /** @override */
+    write(data, severity) {
+        // We need to track newlines to ensure that the prefix is added to each line
+        let currentIndex = 0;
+        // eslint-disable-next-line @rushstack/no-new-null
+        let newlineMatch;
+        while ((newlineMatch = this._newlineRegex.exec(data))) {
+            // Extract the line, add the prefix, and write it out with the newline
+            const newlineIndex = newlineMatch.index;
+            const newIndex = newlineIndex + newlineMatch[0].length;
+            const prefix = this._isOnNewline ? this._getPrefix() : '';
+            const dataToWrite = `${prefix}${data.substring(currentIndex, newIndex)}`;
+            this._parentTerminalProvider.write(dataToWrite, severity);
+            // Update the currentIndex to start the search from the char after the newline
+            currentIndex = newIndex;
+            this._isOnNewline = true;
+        }
+        // The remaining data is not postfixed by a newline, so write out the data and set _isNewline to false
+        const remainingData = data.substring(currentIndex);
+        if (remainingData.length) {
+            const prefix = this._isOnNewline ? this._getPrefix() : '';
+            this._parentTerminalProvider.write(`${prefix}${remainingData}`, severity);
+            this._isOnNewline = false;
+        }
+    }
+}
+exports.PrefixProxyTerminalProvider = PrefixProxyTerminalProvider;
+//# sourceMappingURL=PrefixProxyTerminalProvider.js.map

package/lib/PrefixProxyTerminalProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrefixProxyTerminalProvider.js","sourceRoot":"","sources":["../src/PrefixProxyTerminalProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAoD;AA6CpD;;;;;GAKG;AACH,MAAa,2BAA2B;IAMtC,YAAmB,OAA4C;QAC7D,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;QAErC,IAAI,CAAC,uBAAuB,GAAG,gBAAgB,CAAC;QAEhD,IAAK,OAAqD,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChF,MAAM,EAAE,MAAM,EAAE,GAAG,OAAoD,CAAC;YACxE,IAAI,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,MAAM,EAAE,SAAS,EAAE,GAAG,OAAqD,CAAC;YAC5E,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzB,gEAAgE;QAChE,IAAI,CAAC,aAAa,GAAG,IAAI,MAAM,CAAC,GAAG,wBAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAClG,CAAC;IAED,gBAAgB;IAChB,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC;IACpD,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC;IACnD,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,IAAY,EAAE,QAAkC;QAC3D,4EAA4E;QAC5E,IAAI,YAAY,GAAW,CAAC,CAAC;QAC7B,kDAAkD;QAClD,IAAI,YAAoC,CAAC;QAEzC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACtD,sEAAsE;YACtE,MAAM,YAAY,GAAW,YAAY,CAAC,KAAK,CAAC;YAChD,MAAM,QAAQ,GAAW,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAC/D,MAAM,MAAM,GAAW,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAClE,MAAM,WAAW,GAAW,GAAG,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;YACjF,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAC1D,8EAA8E;YAC9E,YAAY,GAAG,QAAQ,CAAC;YACxB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;QAED,sGAAsG;QACtG,MAAM,aAAa,GAAW,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC3D,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,MAAM,GAAW,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAClE,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,GAAG,MAAM,GAAG,aAAa,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC1E,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,CAAC;IACH,CAAC;CACF;AA9DD,kEA8DC","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 { Text } from '@rushstack/node-core-library';\nimport type { ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';\n\n/**\n * @beta\n */\nexport interface IPrefixProxyTerminalProviderOptionsBase {\n  /**\n   * The {@link ITerminalProvider} that will be wrapped.\n   */\n  terminalProvider: ITerminalProvider;\n}\n\n/**\n * Options for {@link PrefixProxyTerminalProvider}, with a static prefix.\n *\n * @beta\n */\nexport interface IStaticPrefixProxyTerminalProviderOptions extends IPrefixProxyTerminalProviderOptionsBase {\n  /**\n   * The prefix that should be added to each line of output.\n   */\n  prefix: string;\n}\n\n/**\n * Options for {@link PrefixProxyTerminalProvider}.\n *\n * @beta\n */\nexport interface IDynamicPrefixProxyTerminalProviderOptions extends IPrefixProxyTerminalProviderOptionsBase {\n  /**\n   * A function that returns the prefix that should be added to each line of output. This is useful\n   * for prefixing each line with a timestamp.\n   */\n  getPrefix: () => string;\n}\n\n/**\n * @beta\n */\nexport type IPrefixProxyTerminalProviderOptions =\n  | IStaticPrefixProxyTerminalProviderOptions\n  | IDynamicPrefixProxyTerminalProviderOptions;\n\n/**\n * Wraps an existing {@link ITerminalProvider} that prefixes each line of output with a specified\n * prefix string.\n *\n * @beta\n */\nexport class PrefixProxyTerminalProvider implements ITerminalProvider {\n  private readonly _parentTerminalProvider: ITerminalProvider;\n  private readonly _getPrefix: () => string;\n  private readonly _newlineRegex: RegExp;\n  private _isOnNewline: boolean;\n\n  public constructor(options: IPrefixProxyTerminalProviderOptions) {\n    const { terminalProvider } = options;\n\n    this._parentTerminalProvider = terminalProvider;\n\n    if ((options as IStaticPrefixProxyTerminalProviderOptions).prefix !== undefined) {\n      const { prefix } = options as IStaticPrefixProxyTerminalProviderOptions;\n      this._getPrefix = () => prefix;\n    } else {\n      const { getPrefix } = options as IDynamicPrefixProxyTerminalProviderOptions;\n      this._getPrefix = getPrefix;\n    }\n\n    this._isOnNewline = true;\n\n    // eslint-disable-next-line @rushstack/security/no-unsafe-regexp\n    this._newlineRegex = new RegExp(`${Text.escapeRegExp(terminalProvider.eolCharacter)}|\\\\n`, 'g');\n  }\n\n  /** @override */\n  public get supportsColor(): boolean {\n    return this._parentTerminalProvider.supportsColor;\n  }\n\n  /** @override */\n  public get eolCharacter(): string {\n    return this._parentTerminalProvider.eolCharacter;\n  }\n\n  /** @override */\n  public write(data: string, severity: TerminalProviderSeverity): void {\n    // We need to track newlines to ensure that the prefix is added to each line\n    let currentIndex: number = 0;\n    // eslint-disable-next-line @rushstack/no-new-null\n    let newlineMatch: RegExpExecArray | null;\n\n    while ((newlineMatch = this._newlineRegex.exec(data))) {\n      // Extract the line, add the prefix, and write it out with the newline\n      const newlineIndex: number = newlineMatch.index;\n      const newIndex: number = newlineIndex + newlineMatch[0].length;\n      const prefix: string = this._isOnNewline ? this._getPrefix() : '';\n      const dataToWrite: string = `${prefix}${data.substring(currentIndex, newIndex)}`;\n      this._parentTerminalProvider.write(dataToWrite, severity);\n      // Update the currentIndex to start the search from the char after the newline\n      currentIndex = newIndex;\n      this._isOnNewline = true;\n    }\n\n    // The remaining data is not postfixed by a newline, so write out the data and set _isNewline to false\n    const remainingData: string = data.substring(currentIndex);\n    if (remainingData.length) {\n      const prefix: string = this._isOnNewline ? this._getPrefix() : '';\n      this._parentTerminalProvider.write(`${prefix}${remainingData}`, severity);\n      this._isOnNewline = false;\n    }\n  }\n}\n"]}

package/lib/PrintUtilities.d.ts

@@ -1,4 +1,4 @@
-import type { ITerminal } from '@rushstack/node-core-library';
+import type { ITerminal } from './ITerminal';
 /**
  * A sensible fallback column width for consoles.
  *

package/lib/PrintUtilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PrintUtilities.d.ts","sourceRoot":"","sources":["../src/PrintUtilities.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE9D;;;;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;;;;;;OAMG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;CA0C/F"}
+{"version":3,"file":"PrintUtilities.d.ts","sourceRoot":"","sources":["../src/PrintUtilities.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;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;;;;;;OAMG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;CA0C/F"}

package/lib/PrintUtilities.js.map

@@ -1 +1 @@
-{"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,CAAC;YAClC,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;QACV,CAAC;QAED,MAAM,gBAAgB,GAAW,UAAU,CAAC,MAAM,CAAC;QAEnD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;QAC5E,CAAC;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,CAAC;YACzB,IAAI,IAAI,CAAC,MAAM,GAAG,gBAAgB,IAAI,aAAa,EAAE,CAAC;gBACpD,YAAY,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,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,CAAC;oBACvE,IAAI,sBAAsB,CAAC,KAAK,GAAG,gBAAgB,GAAG,qBAAqB,GAAG,aAAa,EAAE,CAAC;wBAC5F,IAAI,mBAAgD,CAAC;wBACrD,IACE,CAAC,uBAAuB;4BACxB,mFAAmF;4BACnF,oBAAoB,EACpB,CAAC;4BACD,mBAAmB,GAAG,sBAAsB,CAAC;wBAC/C,CAAC;6BAAM,CAAC;4BACN,mBAAmB,GAAG,uBAAuB,CAAC;wBAChD,CAAC;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;oBACpF,CAAC;yBAAM,CAAC;wBACN,oBAAoB,GAAG,KAAK,CAAC;oBAC/B,CAAC;oBAED,uBAAuB,GAAG,sBAAsB,CAAC;gBACnD,CAAC;gBAED,IAAI,qBAAqB,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;oBACxC,YAAY,CAAC,IAAI,CAAC,UAAU,GAAG,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,CAAC;gBAC/F,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAmB,EAAE,QAAiB;QACrF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,YAAY,GAAW,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;YACvF,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,aAAa,GAAW,QAAQ,GAAG,EAAE,CAAC;QAC5C,MAAM,mBAAmB,GAAa,cAAc,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAC9F,IAAI,iBAAiB,GAAW,CAAC,CAAC;QAClC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;YACvC,MAAM,WAAW,GAAW,IAAI,CAAC,IAAI,EAAE,CAAC;YACxC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,iBAAiB,GAAG,QAAQ,GAAG,CAAC,EAAE,CAAC;YACrC,qFAAqF;YACrF,gBAAgB;YAChB,WAAW;YACX,gBAAgB;YAChB,MAAM,eAAe,GAAW,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3D,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YACpC,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;gBACvC,QAAQ,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACjC,CAAC;YAED,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,gBAAgB;YAChB,gBAAgB;YAChB,gBAAgB;YAChB,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACrD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;gBACvC,MAAM,OAAO,GAAW,QAAQ,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC1D,MAAM,WAAW,GAAW,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;gBACpD,MAAM,YAAY,GAAW,OAAO,GAAG,WAAW,CAAC;gBACnD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YAC/F,CAAC;YACD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;CACF;AAvMD,wCAuMC","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 type { 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 message - The message to display.\n   * @param terminal - The terminal to write the message to.\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\n    const maxLineLength: number = boxWidth - 10;\n    const wrappedMessageLines: string[] = PrintUtilities.wrapWordsToLines(message, maxLineLength);\n    let longestLineLength: number = 0;\n    const trimmedLines: string[] = [];\n    for (const line of wrappedMessageLines) {\n      const trimmedLine: string = line.trim();\n      trimmedLines.push(trimmedLine);\n      longestLineLength = Math.max(longestLineLength, trimmedLine.length);\n    }\n\n    if (longestLineLength > boxWidth - 2) {\n      // If the longest line is longer than the box, print bars above and below the message\n      // ═════════════\n      //  Message\n      // ═════════════\n      const headerAndFooter: string = ` ${'═'.repeat(boxWidth)}`;\n      terminal.writeLine(headerAndFooter);\n      for (const line of wrappedMessageLines) {\n        terminal.writeLine(` ${line}`);\n      }\n\n      terminal.writeLine(headerAndFooter);\n    } else {\n      // ╔═══════════╗\n      // ║  Message  ║\n      // ╚═══════════╝\n      terminal.writeLine(` ╔${'═'.repeat(boxWidth - 2)}╗`);\n      for (const trimmedLine of trimmedLines) {\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}\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,CAAC;YAClC,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;QACV,CAAC;QAED,MAAM,gBAAgB,GAAW,UAAU,CAAC,MAAM,CAAC;QAEnD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;QAC5E,CAAC;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,CAAC;YACzB,IAAI,IAAI,CAAC,MAAM,GAAG,gBAAgB,IAAI,aAAa,EAAE,CAAC;gBACpD,YAAY,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,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,CAAC;oBACvE,IAAI,sBAAsB,CAAC,KAAK,GAAG,gBAAgB,GAAG,qBAAqB,GAAG,aAAa,EAAE,CAAC;wBAC5F,IAAI,mBAAgD,CAAC;wBACrD,IACE,CAAC,uBAAuB;4BACxB,mFAAmF;4BACnF,oBAAoB,EACpB,CAAC;4BACD,mBAAmB,GAAG,sBAAsB,CAAC;wBAC/C,CAAC;6BAAM,CAAC;4BACN,mBAAmB,GAAG,uBAAuB,CAAC;wBAChD,CAAC;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;oBACpF,CAAC;yBAAM,CAAC;wBACN,oBAAoB,GAAG,KAAK,CAAC;oBAC/B,CAAC;oBAED,uBAAuB,GAAG,sBAAsB,CAAC;gBACnD,CAAC;gBAED,IAAI,qBAAqB,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;oBACxC,YAAY,CAAC,IAAI,CAAC,UAAU,GAAG,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,CAAC;gBAC/F,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAmB,EAAE,QAAiB;QACrF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,YAAY,GAAW,cAAc,CAAC,eAAe,EAAE,IAAI,6BAAqB,CAAC;YACvF,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,aAAa,GAAW,QAAQ,GAAG,EAAE,CAAC;QAC5C,MAAM,mBAAmB,GAAa,cAAc,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAC9F,IAAI,iBAAiB,GAAW,CAAC,CAAC;QAClC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;YACvC,MAAM,WAAW,GAAW,IAAI,CAAC,IAAI,EAAE,CAAC;YACxC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,iBAAiB,GAAG,QAAQ,GAAG,CAAC,EAAE,CAAC;YACrC,qFAAqF;YACrF,gBAAgB;YAChB,WAAW;YACX,gBAAgB;YAChB,MAAM,eAAe,GAAW,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3D,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YACpC,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;gBACvC,QAAQ,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACjC,CAAC;YAED,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,gBAAgB;YAChB,gBAAgB;YAChB,gBAAgB;YAChB,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACrD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;gBACvC,MAAM,OAAO,GAAW,QAAQ,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC1D,MAAM,WAAW,GAAW,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;gBACpD,MAAM,YAAY,GAAW,OAAO,GAAG,WAAW,CAAC;gBACnD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YAC/F,CAAC;YACD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;CACF;AAvMD,wCAuMC","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 type { ITerminal } from './ITerminal';\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 message - The message to display.\n   * @param terminal - The terminal to write the message to.\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\n    const maxLineLength: number = boxWidth - 10;\n    const wrappedMessageLines: string[] = PrintUtilities.wrapWordsToLines(message, maxLineLength);\n    let longestLineLength: number = 0;\n    const trimmedLines: string[] = [];\n    for (const line of wrappedMessageLines) {\n      const trimmedLine: string = line.trim();\n      trimmedLines.push(trimmedLine);\n      longestLineLength = Math.max(longestLineLength, trimmedLine.length);\n    }\n\n    if (longestLineLength > boxWidth - 2) {\n      // If the longest line is longer than the box, print bars above and below the message\n      // ═════════════\n      //  Message\n      // ═════════════\n      const headerAndFooter: string = ` ${'═'.repeat(boxWidth)}`;\n      terminal.writeLine(headerAndFooter);\n      for (const line of wrappedMessageLines) {\n        terminal.writeLine(` ${line}`);\n      }\n\n      terminal.writeLine(headerAndFooter);\n    } else {\n      // ╔═══════════╗\n      // ║  Message  ║\n      // ╚═══════════╝\n      terminal.writeLine(` ╔${'═'.repeat(boxWidth - 2)}╗`);\n      for (const trimmedLine of trimmedLines) {\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}\n"]}

package/lib/RemoveColorsTextRewriter.js

@@ -3,7 +3,7 @@
 // See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoveColorsTextRewriter = void 0;
-const node_core_library_1 = require("@rushstack/node-core-library");
+const AnsiEscape_1 = require("./AnsiEscape");
 const TextRewriter_1 = require("./TextRewriter");
 var State;
 (function (State) {
@@ -75,7 +75,7 @@ class RemoveColorsTextRewriter extends TextRewriter_1.TextRewriter {
                     // Stop when we reach any character that is not [\x30-\x3f] or [\x20-\x2f]
                     const code = c.charCodeAt(0);
                     if (code < 0x20 || code > 0x3f) {
-                        result += node_core_library_1.AnsiEscape.removeCodes(state.buffer);
+                        result += AnsiEscape_1.AnsiEscape.removeCodes(state.buffer);
                         state.buffer = '';
                         state.parseState = State.Start;
                     }

package/lib/RemoveColorsTextRewriter.js.map

@@ -1 +1 @@
-{"version":3,"file":"RemoveColorsTextRewriter.js","sourceRoot":"","sources":["../src/RemoveColorsTextRewriter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAA0D;AAC1D,iDAAsE;AAEtE,IAAK,KAOJ;AAPD,WAAK,KAAK;IACR,2DAA2D;IAC3D,mCAAK,CAAA;IACL,sCAAsC;IACtC,uDAAe,CAAA;IACf,kDAAkD;IAClD,iDAAY,CAAA;AACd,CAAC,EAPI,KAAK,KAAL,KAAK,QAOT;AAOD;;;;;;;;;GASG;AACH,MAAa,wBAAyB,SAAQ,2BAAY;IACjD,UAAU;QACf,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,KAAK,EAAoC,CAAC;IACnF,CAAC;IAEM,OAAO,CAAC,YAA+B,EAAE,IAAY;QAC1D,MAAM,KAAK,GAAmC,YAA8C,CAAC;QAE7F,6CAA6C;QAC7C,EAAE;QACF,mDAAmD;QACnD,EAAE;QACF,MAAM,GAAG,GAAW,MAAM,CAAC;QAE3B,IAAI,MAAM,GAAW,EAAE,CAAC;QACxB,IAAI,KAAK,GAAW,CAAC,CAAC;QAEtB,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;gBACrC,iEAAiE;gBAEjE,MAAM,QAAQ,GAAW,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAClD,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;oBACjB,kEAAkE;oBAClE,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChC,MAAM;gBACR,CAAC;gBAED,yCAAyC;gBACzC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBAE1C,uCAAuC;gBACvC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;gBACnB,KAAK,GAAG,QAAQ,GAAG,CAAC,CAAC;gBACrB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,eAAe,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,gFAAgF;gBAEhF,yCAAyC;gBACzC,MAAM,CAAC,GAAW,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC9B,EAAE,KAAK,CAAC;gBACR,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;gBAElB,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,eAAe,EAAE,CAAC;oBAC/C,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;wBACd,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACN,uDAAuD;wBACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;wBACvB,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;wBAClB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;oBACjC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,qCAAqC;oBAErC,0EAA0E;oBAC1E,MAAM,IAAI,GAAW,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;oBACrC,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,IAAI,EAAE,CAAC;wBAC/B,MAAM,IAAI,8BAAU,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;wBAC/C,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;wBAClB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;oBACjC,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,YAA+B;QAC1C,MAAM,KAAK,GAAmC,YAA8C,CAAC;QAE7F,MAAM,MAAM,GAAW,KAAK,CAAC,MAAM,CAAC;QACpC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA5ED,4DA4EC","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 { AnsiEscape } from '@rushstack/node-core-library';\nimport { TextRewriter, type TextRewriterState } from './TextRewriter';\n\nenum State {\n  // Buffer is empty, and we're looking for the ESC character\n  Start,\n  // We're looking for the '[' character\n  AwaitingBracket,\n  // We're reading the codes after the '[' character\n  ReadingCodes\n}\n\ninterface IRemoveColorsTextRewriterState extends TextRewriterState {\n  buffer: string;\n  parseState: State;\n}\n\n/**\n * For use with {@link TextRewriterTransform}, this rewriter removes ANSI escape codes\n * including colored text.\n *\n * @remarks\n * The implementation also removes other ANSI escape codes such as cursor positioning.\n * The specific set of affected codes may be adjusted in the future.\n *\n * @public\n */\nexport class RemoveColorsTextRewriter extends TextRewriter {\n  public initialize(): TextRewriterState {\n    return { buffer: '', parseState: State.Start } as IRemoveColorsTextRewriterState;\n  }\n\n  public process(unknownState: TextRewriterState, text: string): string {\n    const state: IRemoveColorsTextRewriterState = unknownState as IRemoveColorsTextRewriterState;\n\n    // We will be matching AnsiEscape._csiRegExp:\n    //\n    //  /\\x1b\\[([\\x30-\\x3f]*[\\x20-\\x2f]*[\\x40-\\x7e])/gu\n    //\n    const ESC: string = '\\x1b';\n\n    let result: string = '';\n    let index: number = 0;\n\n    while (index < text.length) {\n      if (state.parseState === State.Start) {\n        // The buffer is empty, which means we haven't found anything yet\n\n        const csiIndex: number = text.indexOf(ESC, index);\n        if (csiIndex < 0) {\n          // We reached the end of \"text\" without finding another CSI prefix\n          result += text.substring(index);\n          break;\n        }\n\n        // Append everything up to the CSI prefix\n        result += text.substring(index, csiIndex);\n\n        // Save the partial match in the buffer\n        state.buffer = ESC;\n        index = csiIndex + 1;\n        state.parseState = State.AwaitingBracket;\n      } else {\n        // The buffer has characters, which means we started matching a partial sequence\n\n        // Read another character into the buffer\n        const c: string = text[index];\n        ++index;\n        state.buffer += c;\n\n        if (state.parseState === State.AwaitingBracket) {\n          if (c === '[') {\n            state.parseState = State.ReadingCodes;\n          } else {\n            // Failed to match, so append the buffer and start over\n            result += state.buffer;\n            state.buffer = '';\n            state.parseState = State.Start;\n          }\n        } else {\n          // state.state === State.ReadingCodes\n\n          // Stop when we reach any character that is not [\\x30-\\x3f] or [\\x20-\\x2f]\n          const code: number = c.charCodeAt(0);\n          if (code < 0x20 || code > 0x3f) {\n            result += AnsiEscape.removeCodes(state.buffer);\n            state.buffer = '';\n            state.parseState = State.Start;\n          }\n        }\n      }\n    }\n\n    return result;\n  }\n\n  public close(unknownState: TextRewriterState): string {\n    const state: IRemoveColorsTextRewriterState = unknownState as IRemoveColorsTextRewriterState;\n\n    const result: string = state.buffer;\n    state.buffer = '';\n    return result;\n  }\n}\n"]}
+{"version":3,"file":"RemoveColorsTextRewriter.js","sourceRoot":"","sources":["../src/RemoveColorsTextRewriter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,6CAA0C;AAC1C,iDAAsE;AAEtE,IAAK,KAOJ;AAPD,WAAK,KAAK;IACR,2DAA2D;IAC3D,mCAAK,CAAA;IACL,sCAAsC;IACtC,uDAAe,CAAA;IACf,kDAAkD;IAClD,iDAAY,CAAA;AACd,CAAC,EAPI,KAAK,KAAL,KAAK,QAOT;AAOD;;;;;;;;;GASG;AACH,MAAa,wBAAyB,SAAQ,2BAAY;IACjD,UAAU;QACf,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,KAAK,EAAoC,CAAC;IACnF,CAAC;IAEM,OAAO,CAAC,YAA+B,EAAE,IAAY;QAC1D,MAAM,KAAK,GAAmC,YAA8C,CAAC;QAE7F,6CAA6C;QAC7C,EAAE;QACF,mDAAmD;QACnD,EAAE;QACF,MAAM,GAAG,GAAW,MAAM,CAAC;QAE3B,IAAI,MAAM,GAAW,EAAE,CAAC;QACxB,IAAI,KAAK,GAAW,CAAC,CAAC;QAEtB,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;gBACrC,iEAAiE;gBAEjE,MAAM,QAAQ,GAAW,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAClD,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;oBACjB,kEAAkE;oBAClE,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChC,MAAM;gBACR,CAAC;gBAED,yCAAyC;gBACzC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBAE1C,uCAAuC;gBACvC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;gBACnB,KAAK,GAAG,QAAQ,GAAG,CAAC,CAAC;gBACrB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,eAAe,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,gFAAgF;gBAEhF,yCAAyC;gBACzC,MAAM,CAAC,GAAW,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC9B,EAAE,KAAK,CAAC;gBACR,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;gBAElB,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,eAAe,EAAE,CAAC;oBAC/C,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;wBACd,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACN,uDAAuD;wBACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;wBACvB,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;wBAClB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;oBACjC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,qCAAqC;oBAErC,0EAA0E;oBAC1E,MAAM,IAAI,GAAW,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;oBACrC,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,IAAI,EAAE,CAAC;wBAC/B,MAAM,IAAI,uBAAU,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;wBAC/C,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;wBAClB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;oBACjC,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,YAA+B;QAC1C,MAAM,KAAK,GAAmC,YAA8C,CAAC;QAE7F,MAAM,MAAM,GAAW,KAAK,CAAC,MAAM,CAAC;QACpC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA5ED,4DA4EC","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 { AnsiEscape } from './AnsiEscape';\nimport { TextRewriter, type TextRewriterState } from './TextRewriter';\n\nenum State {\n  // Buffer is empty, and we're looking for the ESC character\n  Start,\n  // We're looking for the '[' character\n  AwaitingBracket,\n  // We're reading the codes after the '[' character\n  ReadingCodes\n}\n\ninterface IRemoveColorsTextRewriterState extends TextRewriterState {\n  buffer: string;\n  parseState: State;\n}\n\n/**\n * For use with {@link TextRewriterTransform}, this rewriter removes ANSI escape codes\n * including colored text.\n *\n * @remarks\n * The implementation also removes other ANSI escape codes such as cursor positioning.\n * The specific set of affected codes may be adjusted in the future.\n *\n * @public\n */\nexport class RemoveColorsTextRewriter extends TextRewriter {\n  public initialize(): TextRewriterState {\n    return { buffer: '', parseState: State.Start } as IRemoveColorsTextRewriterState;\n  }\n\n  public process(unknownState: TextRewriterState, text: string): string {\n    const state: IRemoveColorsTextRewriterState = unknownState as IRemoveColorsTextRewriterState;\n\n    // We will be matching AnsiEscape._csiRegExp:\n    //\n    //  /\\x1b\\[([\\x30-\\x3f]*[\\x20-\\x2f]*[\\x40-\\x7e])/gu\n    //\n    const ESC: string = '\\x1b';\n\n    let result: string = '';\n    let index: number = 0;\n\n    while (index < text.length) {\n      if (state.parseState === State.Start) {\n        // The buffer is empty, which means we haven't found anything yet\n\n        const csiIndex: number = text.indexOf(ESC, index);\n        if (csiIndex < 0) {\n          // We reached the end of \"text\" without finding another CSI prefix\n          result += text.substring(index);\n          break;\n        }\n\n        // Append everything up to the CSI prefix\n        result += text.substring(index, csiIndex);\n\n        // Save the partial match in the buffer\n        state.buffer = ESC;\n        index = csiIndex + 1;\n        state.parseState = State.AwaitingBracket;\n      } else {\n        // The buffer has characters, which means we started matching a partial sequence\n\n        // Read another character into the buffer\n        const c: string = text[index];\n        ++index;\n        state.buffer += c;\n\n        if (state.parseState === State.AwaitingBracket) {\n          if (c === '[') {\n            state.parseState = State.ReadingCodes;\n          } else {\n            // Failed to match, so append the buffer and start over\n            result += state.buffer;\n            state.buffer = '';\n            state.parseState = State.Start;\n          }\n        } else {\n          // state.state === State.ReadingCodes\n\n          // Stop when we reach any character that is not [\\x30-\\x3f] or [\\x20-\\x2f]\n          const code: number = c.charCodeAt(0);\n          if (code < 0x20 || code > 0x3f) {\n            result += AnsiEscape.removeCodes(state.buffer);\n            state.buffer = '';\n            state.parseState = State.Start;\n          }\n        }\n      }\n    }\n\n    return result;\n  }\n\n  public close(unknownState: TextRewriterState): string {\n    const state: IRemoveColorsTextRewriterState = unknownState as IRemoveColorsTextRewriterState;\n\n    const result: string = state.buffer;\n    state.buffer = '';\n    return result;\n  }\n}\n"]}

package/lib/StringBufferTerminalProvider.d.ts

@@ -0,0 +1,63 @@
+import { type ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';
+/**
+ * @beta
+ */
+export interface IStringBufferOutputOptions {
+    /**
+     * If set to true, special characters like \\n, \\r, and the \\u001b character
+     * in color control tokens will get normalized to [-n-], [-r-], and [-x-] respectively
+     *
+     * This option defaults to `true`
+     */
+    normalizeSpecialCharacters: boolean;
+}
+/**
+ * Terminal provider that stores written data in buffers separated by severity.
+ * This terminal provider is designed to be used when code that prints to a terminal
+ * is being unit tested.
+ *
+ * @beta
+ */
+export declare class StringBufferTerminalProvider implements ITerminalProvider {
+    private _standardBuffer;
+    private _verboseBuffer;
+    private _debugBuffer;
+    private _warningBuffer;
+    private _errorBuffer;
+    private _supportsColor;
+    constructor(supportsColor?: boolean);
+    /**
+     * {@inheritDoc ITerminalProvider.write}
+     */
+    write(data: string, severity: TerminalProviderSeverity): void;
+    /**
+     * {@inheritDoc ITerminalProvider.eolCharacter}
+     */
+    get eolCharacter(): string;
+    /**
+     * {@inheritDoc ITerminalProvider.supportsColor}
+     */
+    get supportsColor(): boolean;
+    /**
+     * Get everything that has been written at log-level severity.
+     */
+    getOutput(options?: IStringBufferOutputOptions): string;
+    /**
+     * Get everything that has been written at verbose-level severity.
+     */
+    getVerbose(options?: IStringBufferOutputOptions): string;
+    /**
+     * Get everything that has been written at debug-level severity.
+     */
+    getDebugOutput(options?: IStringBufferOutputOptions): string;
+    /**
+     * Get everything that has been written at error-level severity.
+     */
+    getErrorOutput(options?: IStringBufferOutputOptions): string;
+    /**
+     * Get everything that has been written at warning-level severity.
+     */
+    getWarningOutput(options?: IStringBufferOutputOptions): string;
+    private _normalizeOutput;
+}
+//# sourceMappingURL=StringBufferTerminalProvider.d.ts.map

package/lib/StringBufferTerminalProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StringBufferTerminalProvider.d.ts","sourceRoot":"","sources":["../src/StringBufferTerminalProvider.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAGvF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,0BAA0B,EAAE,OAAO,CAAC;CACrC;AAED;;;;;;GAMG;AACH,qBAAa,4BAA6B,YAAW,iBAAiB;IACpE,OAAO,CAAC,eAAe,CAAsC;IAC7D,OAAO,CAAC,cAAc,CAAsC;IAC5D,OAAO,CAAC,YAAY,CAAsC;IAC1D,OAAO,CAAC,cAAc,CAAsC;IAC5D,OAAO,CAAC,YAAY,CAAsC;IAE1D,OAAO,CAAC,cAAc,CAAU;gBAEb,aAAa,GAAE,OAAe;IAIjD;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,wBAAwB,GAAG,IAAI;IA8BpE;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;OAEG;IACI,SAAS,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAI9D;;OAEG;IACI,UAAU,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAI/D;;OAEG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAInE;;OAEG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAInE;;OAEG;IACI,gBAAgB,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAIrE,OAAO,CAAC,gBAAgB;CAezB"}

package/lib/StringBufferTerminalProvider.js

@@ -0,0 +1,107 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringBufferTerminalProvider = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const ITerminalProvider_1 = require("./ITerminalProvider");
+const AnsiEscape_1 = require("./AnsiEscape");
+/**
+ * Terminal provider that stores written data in buffers separated by severity.
+ * This terminal provider is designed to be used when code that prints to a terminal
+ * is being unit tested.
+ *
+ * @beta
+ */
+class StringBufferTerminalProvider {
+    constructor(supportsColor = false) {
+        this._standardBuffer = new node_core_library_1.StringBuilder();
+        this._verboseBuffer = new node_core_library_1.StringBuilder();
+        this._debugBuffer = new node_core_library_1.StringBuilder();
+        this._warningBuffer = new node_core_library_1.StringBuilder();
+        this._errorBuffer = new node_core_library_1.StringBuilder();
+        this._supportsColor = supportsColor;
+    }
+    /**
+     * {@inheritDoc ITerminalProvider.write}
+     */
+    write(data, severity) {
+        switch (severity) {
+            case ITerminalProvider_1.TerminalProviderSeverity.warning: {
+                this._warningBuffer.append(data);
+                break;
+            }
+            case ITerminalProvider_1.TerminalProviderSeverity.error: {
+                this._errorBuffer.append(data);
+                break;
+            }
+            case ITerminalProvider_1.TerminalProviderSeverity.verbose: {
+                this._verboseBuffer.append(data);
+                break;
+            }
+            case ITerminalProvider_1.TerminalProviderSeverity.debug: {
+                this._debugBuffer.append(data);
+                break;
+            }
+            case ITerminalProvider_1.TerminalProviderSeverity.log:
+            default: {
+                this._standardBuffer.append(data);
+                break;
+            }
+        }
+    }
+    /**
+     * {@inheritDoc ITerminalProvider.eolCharacter}
+     */
+    get eolCharacter() {
+        return '[n]';
+    }
+    /**
+     * {@inheritDoc ITerminalProvider.supportsColor}
+     */
+    get supportsColor() {
+        return this._supportsColor;
+    }
+    /**
+     * Get everything that has been written at log-level severity.
+     */
+    getOutput(options) {
+        return this._normalizeOutput(this._standardBuffer.toString(), options);
+    }
+    /**
+     * Get everything that has been written at verbose-level severity.
+     */
+    getVerbose(options) {
+        return this._normalizeOutput(this._verboseBuffer.toString(), options);
+    }
+    /**
+     * Get everything that has been written at debug-level severity.
+     */
+    getDebugOutput(options) {
+        return this._normalizeOutput(this._debugBuffer.toString(), options);
+    }
+    /**
+     * Get everything that has been written at error-level severity.
+     */
+    getErrorOutput(options) {
+        return this._normalizeOutput(this._errorBuffer.toString(), options);
+    }
+    /**
+     * Get everything that has been written at warning-level severity.
+     */
+    getWarningOutput(options) {
+        return this._normalizeOutput(this._warningBuffer.toString(), options);
+    }
+    _normalizeOutput(s, options) {
+        options = Object.assign({ normalizeSpecialCharacters: true }, (options || {}));
+        s = node_core_library_1.Text.convertToLf(s);
+        if (options.normalizeSpecialCharacters) {
+            return AnsiEscape_1.AnsiEscape.formatForTests(s, { encodeNewlines: true });
+        }
+        else {
+            return s;
+        }
+    }
+}
+exports.StringBufferTerminalProvider = StringBufferTerminalProvider;
+//# sourceMappingURL=StringBufferTerminalProvider.js.map

package/lib/StringBufferTerminalProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StringBufferTerminalProvider.js","sourceRoot":"","sources":["../src/StringBufferTerminalProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAmE;AACnE,2DAAuF;AACvF,6CAA0C;AAe1C;;;;;;GAMG;AACH,MAAa,4BAA4B;IASvC,YAAmB,gBAAyB,KAAK;QARzC,oBAAe,GAAkB,IAAI,iCAAa,EAAE,CAAC;QACrD,mBAAc,GAAkB,IAAI,iCAAa,EAAE,CAAC;QACpD,iBAAY,GAAkB,IAAI,iCAAa,EAAE,CAAC;QAClD,mBAAc,GAAkB,IAAI,iCAAa,EAAE,CAAC;QACpD,iBAAY,GAAkB,IAAI,iCAAa,EAAE,CAAC;QAKxD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAY,EAAE,QAAkC;QAC3D,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,4CAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,GAAG,CAAC;YAClC,OAAO,CAAC,CAAC,CAAC;gBACR,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAClC,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,OAAoC;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,OAAoC;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAoC;QACxD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAoC;QACxD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,OAAoC;QAC1D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAEO,gBAAgB,CAAC,CAAS,EAAE,OAA+C;QACjF,OAAO,mBACL,0BAA0B,EAAE,IAAI,IAE7B,CAAC,OAAO,IAAI,EAAE,CAAC,CACnB,CAAC;QAEF,CAAC,GAAG,wBAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAExB,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;YACvC,OAAO,uBAAU,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;CACF;AA9GD,oEA8GC","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 { StringBuilder, Text } from '@rushstack/node-core-library';\nimport { type ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';\nimport { AnsiEscape } from './AnsiEscape';\n\n/**\n * @beta\n */\nexport interface IStringBufferOutputOptions {\n  /**\n   * If set to true, special characters like \\\\n, \\\\r, and the \\\\u001b character\n   * in color control tokens will get normalized to [-n-], [-r-], and [-x-] respectively\n   *\n   * This option defaults to `true`\n   */\n  normalizeSpecialCharacters: boolean;\n}\n\n/**\n * Terminal provider that stores written data in buffers separated by severity.\n * This terminal provider is designed to be used when code that prints to a terminal\n * is being unit tested.\n *\n * @beta\n */\nexport class StringBufferTerminalProvider implements ITerminalProvider {\n  private _standardBuffer: StringBuilder = new StringBuilder();\n  private _verboseBuffer: StringBuilder = new StringBuilder();\n  private _debugBuffer: StringBuilder = new StringBuilder();\n  private _warningBuffer: StringBuilder = new StringBuilder();\n  private _errorBuffer: StringBuilder = new StringBuilder();\n\n  private _supportsColor: boolean;\n\n  public constructor(supportsColor: boolean = false) {\n    this._supportsColor = supportsColor;\n  }\n\n  /**\n   * {@inheritDoc ITerminalProvider.write}\n   */\n  public write(data: string, severity: TerminalProviderSeverity): void {\n    switch (severity) {\n      case TerminalProviderSeverity.warning: {\n        this._warningBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.error: {\n        this._errorBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.verbose: {\n        this._verboseBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.debug: {\n        this._debugBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.log:\n      default: {\n        this._standardBuffer.append(data);\n        break;\n      }\n    }\n  }\n\n  /**\n   * {@inheritDoc ITerminalProvider.eolCharacter}\n   */\n  public get eolCharacter(): string {\n    return '[n]';\n  }\n\n  /**\n   * {@inheritDoc ITerminalProvider.supportsColor}\n   */\n  public get supportsColor(): boolean {\n    return this._supportsColor;\n  }\n\n  /**\n   * Get everything that has been written at log-level severity.\n   */\n  public getOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._standardBuffer.toString(), options);\n  }\n\n  /**\n   * Get everything that has been written at verbose-level severity.\n   */\n  public getVerbose(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._verboseBuffer.toString(), options);\n  }\n\n  /**\n   * Get everything that has been written at debug-level severity.\n   */\n  public getDebugOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._debugBuffer.toString(), options);\n  }\n\n  /**\n   * Get everything that has been written at error-level severity.\n   */\n  public getErrorOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._errorBuffer.toString(), options);\n  }\n\n  /**\n   * Get everything that has been written at warning-level severity.\n   */\n  public getWarningOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._warningBuffer.toString(), options);\n  }\n\n  private _normalizeOutput(s: string, options: IStringBufferOutputOptions | undefined): string {\n    options = {\n      normalizeSpecialCharacters: true,\n\n      ...(options || {})\n    };\n\n    s = Text.convertToLf(s);\n\n    if (options.normalizeSpecialCharacters) {\n      return AnsiEscape.formatForTests(s, { encodeNewlines: true });\n    } else {\n      return s;\n    }\n  }\n}\n"]}