@rushstack/terminal 0.21.0 → 0.22.1

package/lib-esm/ITerminal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITerminal.js","sourceRoot":"","sources":["../src/ITerminal.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D","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 { ITerminalProvider } from './ITerminalProvider';\n\n/**\n * @beta\n */\nexport interface ITerminalWriteOptions {\n  /**\n   * If set to true, SGR parameters will not be replaced by the terminal\n   * standard (i.e. - red for errors, yellow for warnings).\n   */\n  doNotOverrideSgrCodes?: boolean;\n}\n\n/**\n * @beta\n */\nexport type TerminalWriteParameters = string[] | [...string[], ITerminalWriteOptions];\n\n/**\n * @beta\n */\nexport interface ITerminal {\n  /**\n   * Subscribe a new terminal provider.\n   */\n  registerProvider(provider: ITerminalProvider): void;\n\n  /**\n   * Unsubscribe a terminal provider. If the provider isn't subscribed, this function does nothing.\n   */\n  unregisterProvider(provider: ITerminalProvider): void;\n\n  /**\n   * Write a generic message to the terminal\n   */\n  write(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write a generic message to the terminal, followed by a newline\n   */\n  writeLine(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write a warning message to the console with yellow text.\n   *\n   * @remarks\n   * The yellow color takes precedence over any other foreground colors set.\n   */\n  writeWarning(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write a warning message to the console with yellow text, followed by a newline.\n   *\n   * @remarks\n   * The yellow color takes precedence over any other foreground colors set.\n   */\n  writeWarningLine(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write an error message to the console with red text.\n   *\n   * @remarks\n   * The red color takes precedence over any other foreground colors set.\n   */\n  writeError(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write an error message to the console with red text, followed by a newline.\n   *\n   * @remarks\n   * The red color takes precedence over any other foreground colors set.\n   */\n  writeErrorLine(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write a verbose-level message.\n   */\n  writeVerbose(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write a verbose-level message followed by a newline.\n   */\n  writeVerboseLine(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write a debug-level message.\n   */\n  writeDebug(...messageParts: TerminalWriteParameters): void;\n\n  /**\n   * Write a debug-level message followed by a newline.\n   */\n  writeDebugLine(...messageParts: TerminalWriteParameters): void;\n}\n"]}

package/lib-esm/ITerminalChunk.js

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * Specifies the kind of data represented by a {@link ITerminalChunk} object.
+ * @public
+ */
+export var TerminalChunkKind;
+(function (TerminalChunkKind) {
+    /**
+     * Indicates a `ITerminalChunk` object representing `stdout` console output.
+     */
+    TerminalChunkKind["Stdout"] = "O";
+    /**
+     * Indicates a `ITerminalChunk` object representing `stderr` console output.
+     */
+    TerminalChunkKind["Stderr"] = "E";
+})(TerminalChunkKind || (TerminalChunkKind = {}));
+//# sourceMappingURL=ITerminalChunk.js.map

package/lib-esm/ITerminalChunk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITerminalChunk.js","sourceRoot":"","sources":["../src/ITerminalChunk.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAUX;AAVD,WAAY,iBAAiB;IAC3B;;OAEG;IACH,iCAAY,CAAA;IAEZ;;OAEG;IACH,iCAAY,CAAA;AACd,CAAC,EAVW,iBAAiB,KAAjB,iBAAiB,QAU5B","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 * Specifies the kind of data represented by a {@link ITerminalChunk} object.\n * @public\n */\nexport enum TerminalChunkKind {\n  /**\n   * Indicates a `ITerminalChunk` object representing `stdout` console output.\n   */\n  Stdout = 'O',\n\n  /**\n   * Indicates a `ITerminalChunk` object representing `stderr` console output.\n   */\n  Stderr = 'E'\n}\n\n/**\n * Represents a chunk of output that will ultimately be written to a {@link TerminalWritable}.\n *\n * @remarks\n * Today `ITerminalChunk` represents the `stdout` and `stderr` text streams.  In the future,\n * we plan to expand it to include other console UI elements such as instructions for displaying\n * an interactive progress bar.  We may also add other metadata, for example tracking whether\n * the `text` string is known to contain color codes or not.\n *\n * The `ITerminalChunk` object should be considered to be immutable once it is created.\n * For example, {@link SplitterTransform} may pass the same chunk to multiple destinations.\n *\n * @public\n */\nexport interface ITerminalChunk {\n  /**\n   * Indicates the kind of information stored in this chunk.\n   *\n   * @remarks\n   * More kinds will be introduced in the future.  Implementors of\n   * {@link TerminalWritable.onWriteChunk} should ignore unrecognized `TerminalChunkKind`\n   * values.  `TerminalTransform` implementors should pass along unrecognized chunks\n   * rather than discarding them.\n   */\n  kind: TerminalChunkKind;\n\n  /**\n   * The next chunk of text from the `stderr` or `stdout` stream.\n   */\n  text: string;\n}\n"]}

package/lib-esm/ITerminalProvider.js

@@ -0,0 +1,29 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * 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 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 || (TerminalProviderSeverity = {}));
+//# sourceMappingURL=ITerminalProvider.js.map

package/lib-esm/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,MAAM,CAAN,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,qEAAG,CAAA;IACH,6EAAO,CAAA;IACP,yEAAK,CAAA;IACL,6EAAO,CAAA;IACP,yEAAK,CAAA;AACP,CAAC,EANW,wBAAwB,KAAxB,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-esm/MockWritable.js

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { AnsiEscape } from './AnsiEscape';
+import { TerminalWritable } from './TerminalWritable';
+/**
+ * A {@link TerminalWritable} subclass for use by unit tests.
+ *
+ * @beta
+ */
+export class MockWritable extends TerminalWritable {
+    constructor() {
+        super(...arguments);
+        this.chunks = [];
+    }
+    onWriteChunk(chunk) {
+        this.chunks.push(chunk);
+    }
+    reset() {
+        this.chunks.length = 0;
+    }
+    getAllOutput() {
+        return AnsiEscape.formatForTests(this.chunks.map((x) => x.text).join(''));
+    }
+    getFormattedChunks() {
+        return this.chunks.map((x) => ({ ...x, text: AnsiEscape.formatForTests(x.text) }));
+    }
+}
+//# sourceMappingURL=MockWritable.js.map

package/lib-esm/MockWritable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockWritable.js","sourceRoot":"","sources":["../src/MockWritable.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,gBAAgB;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,UAAU,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,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAmB,CAAC,CAAC;IACvG,CAAC;CACF","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-esm/NoOpTerminalProvider.js

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * 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 class NoOpTerminalProvider {
+    /**
+     * {@inheritDoc ITerminalProvider.write}
+     */
+    write(data, severity) {
+        // no-op
+    }
+    /**
+     * {@inheritDoc ITerminalProvider.eolCharacter}
+     */
+    get eolCharacter() {
+        return '\n';
+    }
+    /**
+     * {@inheritDoc ITerminalProvider.supportsColor}
+     */
+    get supportsColor() {
+        return false;
+    }
+}
+//# sourceMappingURL=NoOpTerminalProvider.js.map

package/lib-esm/NoOpTerminalProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NoOpTerminalProvider.js","sourceRoot":"","sources":["../src/NoOpTerminalProvider.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAI3D;;;;;;GAMG;AACH,MAAM,OAAO,oBAAoB;IAC/B;;OAEG;IACI,KAAK,CAAC,IAAY,EAAE,QAAkC;QAC3D,QAAQ;IACV,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;CACF","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 { ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';\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 NoOpTerminalProvider implements ITerminalProvider {\n  /**\n   * {@inheritDoc ITerminalProvider.write}\n   */\n  public write(data: string, severity: TerminalProviderSeverity): void {\n    // no-op\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 false;\n  }\n}\n"]}

package/lib-esm/NormalizeNewlinesTextRewriter.js

@@ -0,0 +1,66 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { Text } from '@rushstack/node-core-library';
+import { TextRewriter } from './TextRewriter';
+/**
+ * For use with {@link TextRewriterTransform}, this rewriter converts all newlines to
+ * a standard format.
+ *
+ * @public
+ */
+export class NormalizeNewlinesTextRewriter extends TextRewriter {
+    constructor(options) {
+        super();
+        this.newlineKind = options.newlineKind;
+        this.newline = Text.getNewline(options.newlineKind);
+        this.ensureNewlineAtEnd = !!options.ensureNewlineAtEnd;
+    }
+    initialize() {
+        return {
+            characterToIgnore: '',
+            incompleteLine: false
+        };
+    }
+    process(unknownState, text) {
+        const state = unknownState;
+        let result = '';
+        if (text.length > 0) {
+            let i = 0;
+            do {
+                const c = text[i];
+                ++i;
+                if (c === state.characterToIgnore) {
+                    state.characterToIgnore = '';
+                }
+                else if (c === '\r') {
+                    result += this.newline;
+                    state.characterToIgnore = '\n';
+                    state.incompleteLine = false;
+                }
+                else if (c === '\n') {
+                    result += this.newline;
+                    state.characterToIgnore = '\r';
+                    state.incompleteLine = false;
+                }
+                else {
+                    result += c;
+                    state.characterToIgnore = '';
+                    state.incompleteLine = true;
+                }
+            } while (i < text.length);
+        }
+        return result;
+    }
+    close(unknownState) {
+        const state = unknownState;
+        state.characterToIgnore = '';
+        if (state.incompleteLine) {
+            state.incompleteLine = false;
+            return this.newline;
+        }
+        else {
+            return '';
+        }
+    }
+}
+//# sourceMappingURL=NormalizeNewlinesTextRewriter.js.map

package/lib-esm/NormalizeNewlinesTextRewriter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NormalizeNewlinesTextRewriter.js","sourceRoot":"","sources":["../src/NormalizeNewlinesTextRewriter.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,IAAI,EAAoB,MAAM,8BAA8B,CAAC;AAEtE,OAAO,EAAE,YAAY,EAA0B,MAAM,gBAAgB,CAAC;AA6BtE;;;;;GAKG;AACH,MAAM,OAAO,6BAA8B,SAAQ,YAAY;IAY7D,YAAmB,OAA8C;QAC/D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;IACzD,CAAC;IAEM,UAAU;QACf,OAAO;YACL,iBAAiB,EAAE,EAAE;YACrB,cAAc,EAAE,KAAK;SACiB,CAAC;IAC3C,CAAC;IAEM,OAAO,CAAC,YAA+B,EAAE,IAAY;QAC1D,MAAM,KAAK,GAAwC,YAAmD,CAAC;QAEvG,IAAI,MAAM,GAAW,EAAE,CAAC;QAExB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,GAAW,CAAC,CAAC;YAElB,GAAG,CAAC;gBACF,MAAM,CAAC,GAAW,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC1B,EAAE,CAAC,CAAC;gBAEJ,IAAI,CAAC,KAAK,KAAK,CAAC,iBAAiB,EAAE,CAAC;oBAClC,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC;gBAC/B,CAAC;qBAAM,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;oBACtB,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC;oBACvB,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC;oBAC/B,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC;gBAC/B,CAAC;qBAAM,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;oBACtB,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC;oBACvB,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC;oBAC/B,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC;gBAC/B,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,CAAC,CAAC;oBACZ,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC;oBAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;gBAC9B,CAAC;YACH,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;QAC5B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,YAA+B;QAC1C,MAAM,KAAK,GAAwC,YAAmD,CAAC;QACvG,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAE7B,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACzB,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC;YAC7B,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;CACF","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, type NewlineKind } from '@rushstack/node-core-library';\n\nimport { TextRewriter, type TextRewriterState } from './TextRewriter';\n\ninterface INormalizeNewlinesTextRewriterState extends TextRewriterState {\n  characterToIgnore: string;\n  incompleteLine: boolean;\n}\n\n/**\n * Constructor options for {@link NormalizeNewlinesTextRewriter}\n *\n * @public\n */\nexport interface INormalizeNewlinesTextRewriterOptions {\n  /**\n   * Specifies how newlines should be represented in the output stream.\n   */\n  newlineKind: NewlineKind;\n\n  /**\n   * If `true`, then `NormalizeNewlinesTextRewriter.close()` will append a newline to\n   * the output if it ends with an incomplete line.\n   *\n   * @remarks\n   * If the output is an empty string, then a newline will NOT be appended,\n   * because writing an empty string does not produce an incomplete line.\n   */\n  ensureNewlineAtEnd?: boolean;\n}\n\n/**\n * For use with {@link TextRewriterTransform}, this rewriter converts all newlines to\n * a standard format.\n *\n * @public\n */\nexport class NormalizeNewlinesTextRewriter extends TextRewriter {\n  /** {@inheritDoc INormalizeNewlinesTextRewriterOptions.newlineKind} */\n  public readonly newlineKind: NewlineKind;\n\n  /**\n   * The specific character sequence that will be used when appending newlines.\n   */\n  public readonly newline: string;\n\n  /** {@inheritDoc INormalizeNewlinesTextRewriterOptions.ensureNewlineAtEnd} */\n  public readonly ensureNewlineAtEnd: boolean;\n\n  public constructor(options: INormalizeNewlinesTextRewriterOptions) {\n    super();\n    this.newlineKind = options.newlineKind;\n    this.newline = Text.getNewline(options.newlineKind);\n    this.ensureNewlineAtEnd = !!options.ensureNewlineAtEnd;\n  }\n\n  public initialize(): TextRewriterState {\n    return {\n      characterToIgnore: '',\n      incompleteLine: false\n    } as INormalizeNewlinesTextRewriterState;\n  }\n\n  public process(unknownState: TextRewriterState, text: string): string {\n    const state: INormalizeNewlinesTextRewriterState = unknownState as INormalizeNewlinesTextRewriterState;\n\n    let result: string = '';\n\n    if (text.length > 0) {\n      let i: number = 0;\n\n      do {\n        const c: string = text[i];\n        ++i;\n\n        if (c === state.characterToIgnore) {\n          state.characterToIgnore = '';\n        } else if (c === '\\r') {\n          result += this.newline;\n          state.characterToIgnore = '\\n';\n          state.incompleteLine = false;\n        } else if (c === '\\n') {\n          result += this.newline;\n          state.characterToIgnore = '\\r';\n          state.incompleteLine = false;\n        } else {\n          result += c;\n          state.characterToIgnore = '';\n          state.incompleteLine = true;\n        }\n      } while (i < text.length);\n    }\n\n    return result;\n  }\n\n  public close(unknownState: TextRewriterState): string {\n    const state: INormalizeNewlinesTextRewriterState = unknownState as INormalizeNewlinesTextRewriterState;\n    state.characterToIgnore = '';\n\n    if (state.incompleteLine) {\n      state.incompleteLine = false;\n      return this.newline;\n    } else {\n      return '';\n    }\n  }\n}\n"]}

package/lib-esm/PrefixProxyTerminalProvider.js

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { Text } from '@rushstack/node-core-library';
+/**
+ * Wraps an existing {@link ITerminalProvider} that prefixes each line of output with a specified
+ * prefix string.
+ *
+ * @beta
+ */
+export 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;
+        this._newlineRegex = new RegExp(`${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;
+        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;
+        }
+    }
+}
+//# sourceMappingURL=PrefixProxyTerminalProvider.js.map

package/lib-esm/PrefixProxyTerminalProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrefixProxyTerminalProvider.js","sourceRoot":"","sources":["../src/PrefixProxyTerminalProvider.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AA8CpD;;;;;GAKG;AACH,MAAM,OAAO,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,IAAI,CAAC,aAAa,GAAG,IAAI,MAAM,CAAC,GAAG,IAAI,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,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","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';\n\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    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    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-esm/PrintUtilities.js

@@ -0,0 +1,146 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { Text } from '@rushstack/node-core-library';
+/**
+ * A sensible fallback column width for consoles.
+ *
+ * @public
+ */
+export const DEFAULT_CONSOLE_WIDTH = 80;
+/**
+ * A collection of utilities for printing messages to the console.
+ *
+ * @public
+ */
+export class PrintUtilities {
+    /**
+     * Returns the width of the console, measured in columns
+     */
+    static getConsoleWidth() {
+        var _a;
+        return (_a = process.stdout) === null || _a === void 0 ? void 0 : _a.columns;
+    }
+    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() || DEFAULT_CONSOLE_WIDTH;
+        }
+        // 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.splitByNewLines(text);
+        const wrappedLines = [];
+        for (const line of lines) {
+            if (line.length + linePrefixLength <= maxLineLength) {
+                wrappedLines.push(linePrefix + line);
+            }
+            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 (previousWhitespaceMatch &&
+                    line.length + linePrefixLength - currentLineStartIndex > maxLineLength) {
+                    const whitespaceToSplitAt = previousWhitespaceMatch;
+                    wrappedLines.push(linePrefix +
+                        lineAdditionalPrefix +
+                        line.substring(currentLineStartIndex, whitespaceToSplitAt.index));
+                    currentLineStartIndex = whitespaceToSplitAt.index + whitespaceToSplitAt[0].length;
+                }
+                if (currentLineStartIndex < line.length) {
+                    wrappedLines.push(linePrefix + lineAdditionalPrefix + line.substring(currentLineStartIndex));
+                }
+            }
+        }
+        return wrappedLines;
+    }
+    /**
+     * Displays a message in the console wrapped in a box UI.
+     *
+     * @param message - The message to display.
+     * @param terminal - The terminal to write the message to.
+     * @param boxWidth - The width of the box, defaults to half of the console width.
+     */
+    static printMessageInBox(message, terminal, boxWidth) {
+        if (!boxWidth) {
+            const consoleWidth = PrintUtilities.getConsoleWidth() || DEFAULT_CONSOLE_WIDTH;
+            boxWidth = Math.floor(consoleWidth / 2);
+        }
+        const maxLineLength = boxWidth - 10;
+        const wrappedMessageLines = PrintUtilities.wrapWordsToLines(message, maxLineLength);
+        let longestLineLength = 0;
+        const trimmedLines = [];
+        for (const line of wrappedMessageLines) {
+            const trimmedLine = line.trim();
+            trimmedLines.push(trimmedLine);
+            longestLineLength = Math.max(longestLineLength, trimmedLine.length);
+        }
+        if (longestLineLength > boxWidth - 2) {
+            // If the longest line is longer than the box, print bars above and below the message
+            // ═════════════
+            //  Message
+            // ═════════════
+            const headerAndFooter = ` ${'═'.repeat(boxWidth)}`;
+            terminal.writeLine(headerAndFooter);
+            for (const line of wrappedMessageLines) {
+                terminal.writeLine(` ${line}`);
+            }
+            terminal.writeLine(headerAndFooter);
+        }
+        else {
+            // ╔═══════════╗
+            // ║  Message  ║
+            // ╚═══════════╝
+            terminal.writeLine(` ╔${'═'.repeat(boxWidth - 2)}╗`);
+            for (const trimmedLine of trimmedLines) {
+                const padding = boxWidth - trimmedLine.length - 2;
+                const leftPadding = Math.floor(padding / 2);
+                const rightPadding = padding - leftPadding;
+                terminal.writeLine(` ║${' '.repeat(leftPadding)}${trimmedLine}${' '.repeat(rightPadding)}║`);
+            }
+            terminal.writeLine(` ╚${'═'.repeat(boxWidth - 2)}╝`);
+        }
+    }
+}
+//# sourceMappingURL=PrintUtilities.js.map

package/lib-esm/PrintUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrintUtilities.js","sourceRoot":"","sources":["../src/PrintUtilities.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAIpD;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAW,EAAE,CAAC;AAEhD;;;;GAIG;AACH,MAAM,OAAO,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,qBAAqB,CAAC;QAC5E,CAAC;QAED,4FAA4F;QAC5F,+DAA+D;QAC/D,MAAM,KAAK,GAAa,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEnD,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,IACE,uBAAuB;oBACvB,IAAI,CAAC,MAAM,GAAG,gBAAgB,GAAG,qBAAqB,GAAG,aAAa,EACtE,CAAC;oBACD,MAAM,mBAAmB,GAAoB,uBAAuB,CAAC;oBAErE,YAAY,CAAC,IAAI,CACf,UAAU;wBACR,oBAAoB;wBACpB,IAAI,CAAC,SAAS,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,KAAK,CAAC,CACnE,CAAC;oBACF,qBAAqB,GAAG,mBAAmB,CAAC,KAAK,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBACpF,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,qBAAqB,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","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';\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.splitByNewLines(text);\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 (\n          previousWhitespaceMatch &&\n          line.length + linePrefixLength - currentLineStartIndex > maxLineLength\n        ) {\n          const whitespaceToSplitAt: RegExpExecArray = previousWhitespaceMatch;\n\n          wrappedLines.push(\n            linePrefix +\n              lineAdditionalPrefix +\n              line.substring(currentLineStartIndex, whitespaceToSplitAt.index)\n          );\n          currentLineStartIndex = whitespaceToSplitAt.index + whitespaceToSplitAt[0].length;\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-esm/ProblemCollector.js

@@ -0,0 +1,85 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { parseProblemMatchersJson } from '@rushstack/problem-matcher';
+import { TerminalWritable } from './TerminalWritable';
+/**
+ * A {@link TerminalWritable} that consumes line-oriented terminal output and extracts structured
+ * problems using one or more {@link @rushstack/problem-matcher#IProblemMatcher | IProblemMatcher} instances.
+ *
+ * @remarks
+ * This collector expects that each incoming {@link ITerminalChunk} represents a single line terminated
+ * by a `"\n"` character (for example when preceded by {@link StderrLineTransform} / `StdioLineTransform`).
+ * If a chunk does not end with a newline an error is thrown to surface incorrect pipeline wiring early.
+ *
+ * @beta
+ */
+export class ProblemCollector extends TerminalWritable {
+    constructor(options) {
+        super(options);
+        this._problems = new Set();
+        if (!options ||
+            ((!options.matchers || options.matchers.length === 0) &&
+                (!options.matcherJson || options.matcherJson.length === 0))) {
+            throw new Error('ProblemCollector requires at least one problem matcher.');
+        }
+        const fromJson = options.matcherJson
+            ? parseProblemMatchersJson(options.matcherJson)
+            : [];
+        this._matchers = [...(options.matchers || []), ...fromJson];
+        if (this._matchers.length === 0) {
+            throw new Error('ProblemCollector requires at least one problem matcher.');
+        }
+        this._onProblem = options.onProblem;
+    }
+    /**
+     * {@inheritdoc IProblemCollector}
+     */
+    get problems() {
+        return this._problems;
+    }
+    /**
+     * {@inheritdoc TerminalWritable}
+     */
+    onWriteChunk(chunk) {
+        var _a;
+        const text = chunk.text;
+        if (text.length === 0 || text[text.length - 1] !== '\n') {
+            throw new Error('ProblemCollector expects chunks that were split into newline terminated lines. ' +
+                'Invalid input: ' +
+                JSON.stringify(text));
+        }
+        for (const matcher of this._matchers) {
+            const problem = matcher.exec(text);
+            if (problem) {
+                const finalized = {
+                    ...problem,
+                    matcherName: matcher.name
+                };
+                this._problems.add(finalized);
+                (_a = this._onProblem) === null || _a === void 0 ? void 0 : _a.call(this, finalized);
+            }
+        }
+    }
+    /**
+     * {@inheritdoc TerminalWritable}
+     */
+    onClose() {
+        var _a;
+        for (const matcher of this._matchers) {
+            if (matcher.flush) {
+                const flushed = matcher.flush();
+                if (flushed && flushed.length > 0) {
+                    for (const problem of flushed) {
+                        const finalized = {
+                            ...problem,
+                            matcherName: matcher.name
+                        };
+                        this._problems.add(finalized);
+                        (_a = this._onProblem) === null || _a === void 0 ? void 0 : _a.call(this, finalized);
+                    }
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=ProblemCollector.js.map

package/lib-esm/ProblemCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProblemCollector.js","sourceRoot":"","sources":["../src/ProblemCollector.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAItE,OAAO,EAAiC,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAuBrF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,gBAAiB,SAAQ,gBAAgB;IAKpD,YAAmB,OAAiC;QAClD,KAAK,CAAC,OAAO,CAAC,CAAC;QAJA,cAAS,GAAkB,IAAI,GAAG,EAAE,CAAC;QAMpD,IACE,CAAC,OAAO;YACR,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;gBACnD,CAAC,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,EAC7D,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC7E,CAAC;QAED,MAAM,QAAQ,GAAsB,OAAO,CAAC,WAAW;YACrD,CAAC,CAAC,wBAAwB,CAAC,OAAO,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,EAAE,CAAC;QACP,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC7E,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,KAAqB;;QAC1C,MAAM,IAAI,GAAW,KAAK,CAAC,IAAI,CAAC;QAChC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CACb,iFAAiF;gBAC/E,iBAAiB;gBACjB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvB,CAAC;QACJ,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,OAAO,GAAqB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrD,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,SAAS,GAAa;oBAC1B,GAAG,OAAO;oBACV,WAAW,EAAE,OAAO,CAAC,IAAI;iBAC1B,CAAC;gBACF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAC9B,MAAA,IAAI,CAAC,UAAU,qDAAG,SAAS,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACO,OAAO;;QACf,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,OAAO,GAAe,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC5C,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClC,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;wBAC9B,MAAM,SAAS,GAAa;4BAC1B,GAAG,OAAO;4BACV,WAAW,EAAE,OAAO,CAAC,IAAI;yBAC1B,CAAC;wBACF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;wBAC9B,MAAA,IAAI,CAAC,UAAU,qDAAG,SAAS,CAAC,CAAC;oBAC/B,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF","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 { parseProblemMatchersJson } from '@rushstack/problem-matcher';\nimport type { IProblemMatcher, IProblemMatcherJson, IProblem } from '@rushstack/problem-matcher';\n\nimport type { ITerminalChunk } from './ITerminalChunk';\nimport { type ITerminalWritableOptions, TerminalWritable } from './TerminalWritable';\nimport type { IProblemCollector } from './IProblemCollector';\n\n/**\n * Constructor options for {@link ProblemCollector}.\n * @beta\n */\nexport interface IProblemCollectorOptions extends ITerminalWritableOptions {\n  /**\n   * The set of matchers that will be applied to each incoming line. Must contain at least one item.\n   */\n  matchers?: IProblemMatcher[];\n  /**\n   * VS Code style problem matcher definitions. These will be converted to\n   * {@link @rushstack/problem-matcher#IProblemMatcher | IProblemMatcher} definitions.\n   */\n  matcherJson?: IProblemMatcherJson[];\n  /**\n   * Optional callback invoked immediately whenever a problem is produced.\n   */\n  onProblem?: (problem: IProblem) => void;\n}\n\n/**\n * A {@link TerminalWritable} that consumes line-oriented terminal output and extracts structured\n * problems using one or more {@link @rushstack/problem-matcher#IProblemMatcher | IProblemMatcher} instances.\n *\n * @remarks\n * This collector expects that each incoming {@link ITerminalChunk} represents a single line terminated\n * by a `\"\\n\"` character (for example when preceded by {@link StderrLineTransform} / `StdioLineTransform`).\n * If a chunk does not end with a newline an error is thrown to surface incorrect pipeline wiring early.\n *\n * @beta\n */\nexport class ProblemCollector extends TerminalWritable implements IProblemCollector {\n  private readonly _matchers: IProblemMatcher[];\n  private readonly _problems: Set<IProblem> = new Set();\n  private readonly _onProblem: ((problem: IProblem) => void) | undefined;\n\n  public constructor(options: IProblemCollectorOptions) {\n    super(options);\n\n    if (\n      !options ||\n      ((!options.matchers || options.matchers.length === 0) &&\n        (!options.matcherJson || options.matcherJson.length === 0))\n    ) {\n      throw new Error('ProblemCollector requires at least one problem matcher.');\n    }\n\n    const fromJson: IProblemMatcher[] = options.matcherJson\n      ? parseProblemMatchersJson(options.matcherJson)\n      : [];\n    this._matchers = [...(options.matchers || []), ...fromJson];\n    if (this._matchers.length === 0) {\n      throw new Error('ProblemCollector requires at least one problem matcher.');\n    }\n    this._onProblem = options.onProblem;\n  }\n\n  /**\n   * {@inheritdoc IProblemCollector}\n   */\n  public get problems(): ReadonlySet<IProblem> {\n    return this._problems;\n  }\n\n  /**\n   * {@inheritdoc TerminalWritable}\n   */\n  protected onWriteChunk(chunk: ITerminalChunk): void {\n    const text: string = chunk.text;\n    if (text.length === 0 || text[text.length - 1] !== '\\n') {\n      throw new Error(\n        'ProblemCollector expects chunks that were split into newline terminated lines. ' +\n          'Invalid input: ' +\n          JSON.stringify(text)\n      );\n    }\n\n    for (const matcher of this._matchers) {\n      const problem: IProblem | false = matcher.exec(text);\n      if (problem) {\n        const finalized: IProblem = {\n          ...problem,\n          matcherName: matcher.name\n        };\n        this._problems.add(finalized);\n        this._onProblem?.(finalized);\n      }\n    }\n  }\n\n  /**\n   * {@inheritdoc TerminalWritable}\n   */\n  protected onClose(): void {\n    for (const matcher of this._matchers) {\n      if (matcher.flush) {\n        const flushed: IProblem[] = matcher.flush();\n        if (flushed && flushed.length > 0) {\n          for (const problem of flushed) {\n            const finalized: IProblem = {\n              ...problem,\n              matcherName: matcher.name\n            };\n            this._problems.add(finalized);\n            this._onProblem?.(finalized);\n          }\n        }\n      }\n    }\n  }\n}\n"]}