@rushstack/terminal 0.21.0 → 0.22.1

package/lib-esm/RemoveColorsTextRewriter.js

@@ -0,0 +1,91 @@
+// 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 { TextRewriter } from './TextRewriter';
+var State;
+(function (State) {
+    // Buffer is empty, and we're looking for the ESC character
+    State[State["Start"] = 0] = "Start";
+    // We're looking for the '[' character
+    State[State["AwaitingBracket"] = 1] = "AwaitingBracket";
+    // We're reading the codes after the '[' character
+    State[State["ReadingCodes"] = 2] = "ReadingCodes";
+})(State || (State = {}));
+/**
+ * For use with {@link TextRewriterTransform}, this rewriter removes ANSI escape codes
+ * including colored text.
+ *
+ * @remarks
+ * The implementation also removes other ANSI escape codes such as cursor positioning.
+ * The specific set of affected codes may be adjusted in the future.
+ *
+ * @public
+ */
+export class RemoveColorsTextRewriter extends TextRewriter {
+    initialize() {
+        return { buffer: '', parseState: State.Start };
+    }
+    process(unknownState, text) {
+        const state = unknownState;
+        // We will be matching AnsiEscape._csiRegExp:
+        //
+        //  /\x1b\[([\x30-\x3f]*[\x20-\x2f]*[\x40-\x7e])/gu
+        //
+        const ESC = '\x1b';
+        let result = '';
+        let index = 0;
+        while (index < text.length) {
+            if (state.parseState === State.Start) {
+                // The buffer is empty, which means we haven't found anything yet
+                const csiIndex = text.indexOf(ESC, index);
+                if (csiIndex < 0) {
+                    // We reached the end of "text" without finding another CSI prefix
+                    result += text.substring(index);
+                    break;
+                }
+                // Append everything up to the CSI prefix
+                result += text.substring(index, csiIndex);
+                // Save the partial match in the buffer
+                state.buffer = ESC;
+                index = csiIndex + 1;
+                state.parseState = State.AwaitingBracket;
+            }
+            else {
+                // The buffer has characters, which means we started matching a partial sequence
+                // Read another character into the buffer
+                const c = text[index];
+                ++index;
+                state.buffer += c;
+                if (state.parseState === State.AwaitingBracket) {
+                    if (c === '[') {
+                        state.parseState = State.ReadingCodes;
+                    }
+                    else {
+                        // Failed to match, so append the buffer and start over
+                        result += state.buffer;
+                        state.buffer = '';
+                        state.parseState = State.Start;
+                    }
+                }
+                else {
+                    // state.state === State.ReadingCodes
+                    // 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 += AnsiEscape.removeCodes(state.buffer);
+                        state.buffer = '';
+                        state.parseState = State.Start;
+                    }
+                }
+            }
+        }
+        return result;
+    }
+    close(unknownState) {
+        const state = unknownState;
+        const result = state.buffer;
+        state.buffer = '';
+        return result;
+    }
+}
+//# sourceMappingURL=RemoveColorsTextRewriter.js.map

package/lib-esm/RemoveColorsTextRewriter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveColorsTextRewriter.js","sourceRoot":"","sources":["../src/RemoveColorsTextRewriter.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAA0B,MAAM,gBAAgB,CAAC;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,MAAM,OAAO,wBAAyB,SAAQ,YAAY;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,UAAU,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","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-esm/SplitterTransform.js

@@ -0,0 +1,74 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { TerminalWritable } from './TerminalWritable';
+/**
+ * Use this instead of {@link TerminalTransform} if you need to output `ITerminalChunk`
+ * data to more than one destination.
+ *
+ * @remarks
+ *
+ * Splitting streams complicates the pipeline topology and can make debugging more difficult.
+ * For this reason, it is modeled as an explicit `SplitterTransform` node, rather than
+ * as a built-in feature of `TerminalTransform`.
+ *
+ * @public
+ */
+export class SplitterTransform extends TerminalWritable {
+    constructor(options) {
+        super();
+        this._destinations = new Set(options.destinations);
+    }
+    get destinations() {
+        return this._destinations;
+    }
+    /**
+     * Adds a destination to the set of destinations. Duplicates are ignored.
+     * Only new chunks received after the destination is added will be sent to it.
+     * @param destination - The destination to add.
+     */
+    addDestination(destination) {
+        this._destinations.add(destination);
+    }
+    /**
+     * Removes a destination from the set of destinations. It will no longer receive chunks, and will be closed, unless
+     * `destination.preventAutoclose` is set to `true`.
+     * @param destination - The destination to remove.
+     * @param close - If `true` (default), the destination will be closed when removed, unless `destination.preventAutoclose` is set to `true`.
+     * @returns `true` if the destination was removed, `false` if it was not found.
+     * @remarks
+     * If the destination is not found, it will not be closed.
+     */
+    removeDestination(destination, close = true) {
+        if (this._destinations.delete(destination)) {
+            if (close && !destination.preventAutoclose) {
+                destination.close();
+            }
+            return true;
+        }
+        return false;
+    }
+    onWriteChunk(chunk) {
+        for (const destination of this._destinations) {
+            destination.writeChunk(chunk);
+        }
+    }
+    onClose() {
+        const errors = [];
+        // If an exception is thrown, try to ensure that the other destinations get closed properly
+        for (const destination of this._destinations) {
+            if (!destination.preventAutoclose) {
+                try {
+                    destination.close();
+                }
+                catch (error) {
+                    errors.push(error);
+                }
+            }
+        }
+        this._destinations.clear();
+        if (errors.length > 0) {
+            throw errors[0];
+        }
+    }
+}
+//# sourceMappingURL=SplitterTransform.js.map

package/lib-esm/SplitterTransform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SplitterTransform.js","sourceRoot":"","sources":["../src/SplitterTransform.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,gBAAgB,EAAiC,MAAM,oBAAoB,CAAC;AAerF;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,iBAAkB,SAAQ,gBAAgB;IAGrD,YAAmB,OAAkC;QACnD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACrD,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,WAA6B;QACjD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACI,iBAAiB,CAAC,WAA6B,EAAE,QAAiB,IAAI;QAC3E,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,KAAK,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBAC3C,WAAW,CAAC,KAAK,EAAE,CAAC;YACtB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAES,YAAY,CAAC,KAAqB;QAC1C,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAES,OAAO;QACf,MAAM,MAAM,GAAY,EAAE,CAAC;QAE3B,2FAA2F;QAC3F,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBAClC,IAAI,CAAC;oBACH,WAAW,CAAC,KAAK,EAAE,CAAC;gBACtB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,CAAC,KAAc,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAE3B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC;QAClB,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 { TerminalWritable, type ITerminalWritableOptions } from './TerminalWritable';\nimport type { ITerminalChunk } from './ITerminalChunk';\n\n/**\n * Constructor options for {@link SplitterTransform}.\n *\n * @public\n */\nexport interface ISplitterTransformOptions extends ITerminalWritableOptions {\n  /**\n   * Each input chunk will be passed to each destination in the iterable.\n   */\n  destinations: Iterable<TerminalWritable>;\n}\n\n/**\n * Use this instead of {@link TerminalTransform} if you need to output `ITerminalChunk`\n * data to more than one destination.\n *\n * @remarks\n *\n * Splitting streams complicates the pipeline topology and can make debugging more difficult.\n * For this reason, it is modeled as an explicit `SplitterTransform` node, rather than\n * as a built-in feature of `TerminalTransform`.\n *\n * @public\n */\nexport class SplitterTransform extends TerminalWritable {\n  private readonly _destinations: Set<TerminalWritable>;\n\n  public constructor(options: ISplitterTransformOptions) {\n    super();\n    this._destinations = new Set(options.destinations);\n  }\n\n  public get destinations(): ReadonlySet<TerminalWritable> {\n    return this._destinations;\n  }\n\n  /**\n   * Adds a destination to the set of destinations. Duplicates are ignored.\n   * Only new chunks received after the destination is added will be sent to it.\n   * @param destination - The destination to add.\n   */\n  public addDestination(destination: TerminalWritable): void {\n    this._destinations.add(destination);\n  }\n\n  /**\n   * Removes a destination from the set of destinations. It will no longer receive chunks, and will be closed, unless\n   * `destination.preventAutoclose` is set to `true`.\n   * @param destination - The destination to remove.\n   * @param close - If `true` (default), the destination will be closed when removed, unless `destination.preventAutoclose` is set to `true`.\n   * @returns `true` if the destination was removed, `false` if it was not found.\n   * @remarks\n   * If the destination is not found, it will not be closed.\n   */\n  public removeDestination(destination: TerminalWritable, close: boolean = true): boolean {\n    if (this._destinations.delete(destination)) {\n      if (close && !destination.preventAutoclose) {\n        destination.close();\n      }\n      return true;\n    }\n    return false;\n  }\n\n  protected onWriteChunk(chunk: ITerminalChunk): void {\n    for (const destination of this._destinations) {\n      destination.writeChunk(chunk);\n    }\n  }\n\n  protected onClose(): void {\n    const errors: Error[] = [];\n\n    // If an exception is thrown, try to ensure that the other destinations get closed properly\n    for (const destination of this._destinations) {\n      if (!destination.preventAutoclose) {\n        try {\n          destination.close();\n        } catch (error) {\n          errors.push(error as Error);\n        }\n      }\n    }\n\n    this._destinations.clear();\n\n    if (errors.length > 0) {\n      throw errors[0];\n    }\n  }\n}\n"]}

package/lib-esm/StdioLineTransform.js

@@ -0,0 +1,111 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { Text, NewlineKind } from '@rushstack/node-core-library';
+import { TerminalChunkKind } from './ITerminalChunk';
+import { TerminalTransform } from './TerminalTransform';
+/**
+ * `StderrLineTransform` normalizes lines that mix characters from `stdout` and `stderr`,
+ * so that each output line is routed entirely to `stdout` or `stderr`.
+ *
+ * @remarks
+ * IMPORTANT: This transform assumes that its input has been normalized to use `"\n"` newlines.
+ *
+ * IMPORTANT: This transform does not produce realtime output, because lines are buffered
+ * until a newline character is encountered.
+ *
+ * Suppose that a poorly behaved process produces output like this:
+ *
+ * ```ts
+ * process.stderr.write('An error occurred, cleaning up');
+ * process.stdout.write('.'); // (delay)
+ * process.stdout.write('.'); // (delay)
+ * process.stdout.write('.');
+ * process.stdout.write('\n');
+ * process.stderr.write('The process completed with errors\n');
+ * ```
+ *
+ * When `stdout` and `stderr` are combined on the console, the mistake in the output would not be noticeable:
+ * ```
+ * An error occurred, cleaning up...
+ * The process completed with errors
+ * ```
+ *
+ * However, if we discard `stdout`, then `stderr` is malformed:
+ * ```
+ * An error occurred, cleaning upThe process completed with errors
+ * ```
+ *
+ * Tooling scripts can introduce these sorts of problems via edge cases that are difficult to find and fix.
+ *
+ * `StderrLineTransform` normalizes the output so that if a combined line contains any `stderr` characters,
+ * then the entire line is routed to `stderr`.  Later, if we discard `stdout`, then the output will
+ * preserve the appropriate context:
+ *
+ * ```
+ * An error occurred, cleaning up...
+ * The process completed with errors
+ * ```
+ *
+ * @privateRemarks
+ * This class is experimental and marked as `@beta`.  The algorithm may need some fine-tuning, or there may
+ * be better solutions to this problem.
+ *
+ * @beta
+ */
+export class StderrLineTransform extends TerminalTransform {
+    constructor(options) {
+        super(options);
+        this._accumulatedLine = '';
+        this._accumulatedStderr = false;
+        this.newline = Text.getNewline(options.newlineKind || NewlineKind.Lf);
+    }
+    onWriteChunk(chunk) {
+        if (chunk.text.indexOf('\r') >= 0) {
+            throw new Error('StderrLineTransform expects chunks with normalized newlines');
+        }
+        // After _newlineNormalizerTransform was applied, we can now assume that all newlines
+        // use the "\n" string
+        const text = chunk.text;
+        let startIndex = 0;
+        while (startIndex < text.length) {
+            if (chunk.kind === TerminalChunkKind.Stderr) {
+                this._accumulatedStderr = true;
+            }
+            const endIndex = text.indexOf('\n', startIndex);
+            if (endIndex < 0) {
+                // we did not find \n, so simply append
+                this._accumulatedLine += text.substring(startIndex);
+                break;
+            }
+            // append everything up to \n
+            this._accumulatedLine += text.substring(startIndex, endIndex);
+            this._processAccumulatedLine();
+            // skip the \n
+            startIndex = endIndex + 1;
+        }
+    }
+    onClose() {
+        if (this._accumulatedLine.length > 0) {
+            this._processAccumulatedLine();
+        }
+        this.autocloseDestination();
+    }
+    _processAccumulatedLine() {
+        this._accumulatedLine += this.newline;
+        if (this._accumulatedStderr) {
+            this.destination.writeChunk({
+                kind: TerminalChunkKind.Stderr,
+                text: this._accumulatedLine
+            });
+        }
+        else {
+            this.destination.writeChunk({
+                kind: TerminalChunkKind.Stdout,
+                text: this._accumulatedLine
+            });
+        }
+        this._accumulatedLine = '';
+        this._accumulatedStderr = false;
+    }
+}
+//# sourceMappingURL=StdioLineTransform.js.map

package/lib-esm/StdioLineTransform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StdioLineTransform.js","sourceRoot":"","sources":["../src/StdioLineTransform.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAuB,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAkC,MAAM,qBAAqB,CAAC;AAaxF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,OAAO,mBAAoB,SAAQ,iBAAiB;IAMxD,YAAmB,OAAmC;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAEhC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAES,YAAY,CAAC,KAAqB;QAC1C,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;QACjF,CAAC;QAED,qFAAqF;QACrF,sBAAsB;QACtB,MAAM,IAAI,GAAW,KAAK,CAAC,IAAI,CAAC;QAChC,IAAI,UAAU,GAAW,CAAC,CAAC;QAE3B,OAAO,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;gBAC5C,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;YACjC,CAAC;YAED,MAAM,QAAQ,GAAW,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACxD,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;gBACjB,uCAAuC;gBACvC,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBACpD,MAAM;YACR,CAAC;YAED,6BAA6B;YAC7B,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAE9D,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAE/B,cAAc;YACd,UAAU,GAAG,QAAQ,GAAG,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAES,OAAO;QACf,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAEO,uBAAuB;QAC7B,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,OAAO,CAAC;QAEtC,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;gBAC1B,IAAI,EAAE,iBAAiB,CAAC,MAAM;gBAC9B,IAAI,EAAE,IAAI,CAAC,gBAAgB;aAC5B,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;gBAC1B,IAAI,EAAE,iBAAiB,CAAC,MAAM;gBAC9B,IAAI,EAAE,IAAI,CAAC,gBAAgB;aAC5B,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAClC,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, NewlineKind } from '@rushstack/node-core-library';\n\nimport { type ITerminalChunk, TerminalChunkKind } from './ITerminalChunk';\nimport { TerminalTransform, type ITerminalTransformOptions } from './TerminalTransform';\n\n/**\n * Constructor options for {@link StderrLineTransform}\n * @beta\n */\nexport interface IStdioLineTransformOptions extends ITerminalTransformOptions {\n  /**\n   * Specifies the kind of newline for the output.\n   */\n  newlineKind?: NewlineKind;\n}\n\n/**\n * `StderrLineTransform` normalizes lines that mix characters from `stdout` and `stderr`,\n * so that each output line is routed entirely to `stdout` or `stderr`.\n *\n * @remarks\n * IMPORTANT: This transform assumes that its input has been normalized to use `\"\\n\"` newlines.\n *\n * IMPORTANT: This transform does not produce realtime output, because lines are buffered\n * until a newline character is encountered.\n *\n * Suppose that a poorly behaved process produces output like this:\n *\n * ```ts\n * process.stderr.write('An error occurred, cleaning up');\n * process.stdout.write('.'); // (delay)\n * process.stdout.write('.'); // (delay)\n * process.stdout.write('.');\n * process.stdout.write('\\n');\n * process.stderr.write('The process completed with errors\\n');\n * ```\n *\n * When `stdout` and `stderr` are combined on the console, the mistake in the output would not be noticeable:\n * ```\n * An error occurred, cleaning up...\n * The process completed with errors\n * ```\n *\n * However, if we discard `stdout`, then `stderr` is malformed:\n * ```\n * An error occurred, cleaning upThe process completed with errors\n * ```\n *\n * Tooling scripts can introduce these sorts of problems via edge cases that are difficult to find and fix.\n *\n * `StderrLineTransform` normalizes the output so that if a combined line contains any `stderr` characters,\n * then the entire line is routed to `stderr`.  Later, if we discard `stdout`, then the output will\n * preserve the appropriate context:\n *\n * ```\n * An error occurred, cleaning up...\n * The process completed with errors\n * ```\n *\n * @privateRemarks\n * This class is experimental and marked as `@beta`.  The algorithm may need some fine-tuning, or there may\n * be better solutions to this problem.\n *\n * @beta\n */\nexport class StderrLineTransform extends TerminalTransform {\n  private _accumulatedLine: string;\n  private _accumulatedStderr: boolean;\n\n  public readonly newline: string;\n\n  public constructor(options: IStdioLineTransformOptions) {\n    super(options);\n\n    this._accumulatedLine = '';\n    this._accumulatedStderr = false;\n\n    this.newline = Text.getNewline(options.newlineKind || NewlineKind.Lf);\n  }\n\n  protected onWriteChunk(chunk: ITerminalChunk): void {\n    if (chunk.text.indexOf('\\r') >= 0) {\n      throw new Error('StderrLineTransform expects chunks with normalized newlines');\n    }\n\n    // After _newlineNormalizerTransform was applied, we can now assume that all newlines\n    // use the \"\\n\" string\n    const text: string = chunk.text;\n    let startIndex: number = 0;\n\n    while (startIndex < text.length) {\n      if (chunk.kind === TerminalChunkKind.Stderr) {\n        this._accumulatedStderr = true;\n      }\n\n      const endIndex: number = text.indexOf('\\n', startIndex);\n      if (endIndex < 0) {\n        // we did not find \\n, so simply append\n        this._accumulatedLine += text.substring(startIndex);\n        break;\n      }\n\n      // append everything up to \\n\n      this._accumulatedLine += text.substring(startIndex, endIndex);\n\n      this._processAccumulatedLine();\n\n      // skip the \\n\n      startIndex = endIndex + 1;\n    }\n  }\n\n  protected onClose(): void {\n    if (this._accumulatedLine.length > 0) {\n      this._processAccumulatedLine();\n    }\n    this.autocloseDestination();\n  }\n\n  private _processAccumulatedLine(): void {\n    this._accumulatedLine += this.newline;\n\n    if (this._accumulatedStderr) {\n      this.destination.writeChunk({\n        kind: TerminalChunkKind.Stderr,\n        text: this._accumulatedLine\n      });\n    } else {\n      this.destination.writeChunk({\n        kind: TerminalChunkKind.Stdout,\n        text: this._accumulatedLine\n      });\n    }\n\n    this._accumulatedLine = '';\n    this._accumulatedStderr = false;\n  }\n}\n"]}

package/lib-esm/StdioSummarizer.js

@@ -0,0 +1,95 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { TerminalChunkKind } from './ITerminalChunk';
+import { TerminalWritable } from './TerminalWritable';
+/**
+ * Summarizes the results of a failed build task by returning a subset of `stderr` output not to exceed
+ * a specified maximum number of lines.
+ *
+ * @remarks
+ * IMPORTANT: This transform assumes that its input was prepared by {@link StderrLineTransform}, so that each
+ * {@link ITerminalChunk.text} item is a single line terminated by a `"\n"` character.
+ *
+ * The {@link IStdioSummarizerOptions.leadingLines} and {@link IStdioSummarizerOptions.trailingLines}
+ * counts specify the maximum number of lines to be returned. Any additional lines will be omitted.
+ * For example, if `leadingLines` and `trailingLines` were set to `3`, then the summary of 16 `stderr` lines might
+ * look like this:
+ *
+ * ```
+ * Line 1
+ * Line 2
+ * Line 3
+ *   ...10 lines omitted...
+ * Line 14
+ * Line 15
+ * Line 16
+ * ```
+ *
+ * If the `stderr` output is completely empty, then the `stdout` output will be summarized instead.
+ *
+ * @beta
+ */
+export class StdioSummarizer extends TerminalWritable {
+    constructor(options) {
+        super(options);
+        this._abridgedOmittedLines = 0;
+        if (!options) {
+            options = {};
+        }
+        this._leadingLines = options.leadingLines !== undefined ? options.leadingLines : 10;
+        this._trailingLines = options.trailingLines !== undefined ? options.trailingLines : 10;
+        this._abridgedLeading = [];
+        this._abridgedTrailing = [];
+        this._abridgedStderr = false;
+    }
+    /**
+     * Returns the summary report.
+     *
+     * @remarks
+     * The `close()` method must be called before `getReport()` can be used.
+     */
+    getReport() {
+        if (this.isOpen) {
+            throw new Error('The summary cannot be prepared until after close() is called.');
+        }
+        const report = [...this._abridgedLeading];
+        if (this._abridgedOmittedLines === 1) {
+            report.push(`  ...${this._abridgedOmittedLines} line omitted...\n`);
+        }
+        if (this._abridgedOmittedLines > 1) {
+            report.push(`  ...${this._abridgedOmittedLines} lines omitted...\n`);
+        }
+        report.push(...this._abridgedTrailing);
+        return report.join('');
+    }
+    onWriteChunk(chunk) {
+        if (chunk.text.length === 0 || chunk.text[chunk.text.length - 1] !== '\n') {
+            throw new Error('StdioSummarizer expects chunks that were separated parsed into lines by StderrLineTransform\n' +
+                ' Invalid input: ' +
+                JSON.stringify(chunk.text));
+        }
+        if (chunk.kind === TerminalChunkKind.Stderr && !this._abridgedStderr) {
+            // The first time we see stderr, switch to capturing stderr
+            this._abridgedStderr = true;
+            this._abridgedLeading.length = 0;
+            this._abridgedTrailing.length = 0;
+            this._abridgedOmittedLines = 0;
+        }
+        else if (this._abridgedStderr && chunk.kind !== TerminalChunkKind.Stderr) {
+            // If we're capturing stderr, then ignore non-stderr input
+            return;
+        }
+        // Did we capture enough leading lines?
+        if (this._abridgedLeading.length < this._leadingLines) {
+            this._abridgedLeading.push(chunk.text);
+            return;
+        }
+        this._abridgedTrailing.push(chunk.text);
+        // If we captured to many trailing lines, omit the extras
+        while (this._abridgedTrailing.length > this._trailingLines) {
+            this._abridgedTrailing.shift();
+            ++this._abridgedOmittedLines;
+        }
+    }
+}
+//# sourceMappingURL=StdioSummarizer.js.map

package/lib-esm/StdioSummarizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StdioSummarizer.js","sourceRoot":"","sources":["../src/StdioSummarizer.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAuB,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAiC,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAoBrF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,eAAgB,SAAQ,gBAAgB;IAYnD,YAAmB,OAAiC;QAClD,KAAK,CAAC,OAAO,CAAC,CAAC;QAJT,0BAAqB,GAAW,CAAC,CAAC;QAMxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;QACpF,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;QAEvF,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,SAAS;QACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACnF,CAAC;QACD,MAAM,MAAM,GAAa,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,qBAAqB,KAAK,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,qBAAqB,oBAAoB,CAAC,CAAC;QACtE,CAAC;QACD,IAAI,IAAI,CAAC,qBAAqB,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,qBAAqB,qBAAqB,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACvC,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAEM,YAAY,CAAC,KAAqB;QACvC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YAC1E,MAAM,IAAI,KAAK,CACb,+FAA+F;gBAC7F,kBAAkB;gBAClB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAC7B,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrE,2DAA2D;YAC3D,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;YAC5B,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;YACjC,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,IAAI,CAAC,eAAe,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;YAC3E,0DAA0D;YAC1D,OAAO;QACT,CAAC;QAED,uCAAuC;QACvC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACtD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAExC,yDAAyD;QACzD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YAC3D,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YAC/B,EAAE,IAAI,CAAC,qBAAqB,CAAC;QAC/B,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 { type ITerminalChunk, TerminalChunkKind } from './ITerminalChunk';\nimport { type ITerminalWritableOptions, TerminalWritable } from './TerminalWritable';\n\n/**\n * Constructor options for {@link StdioSummarizer}.\n * @beta\n */\nexport interface IStdioSummarizerOptions extends ITerminalWritableOptions {\n  /**\n   * Specifies the maximum number of leading lines to include in the summary.\n   * @defaultValue `10`\n   */\n  leadingLines?: number;\n\n  /**\n   * Specifies the maximum number of trailing lines to include in the summary.\n   * @defaultValue `10`\n   */\n  trailingLines?: number;\n}\n\n/**\n * Summarizes the results of a failed build task by returning a subset of `stderr` output not to exceed\n * a specified maximum number of lines.\n *\n * @remarks\n * IMPORTANT: This transform assumes that its input was prepared by {@link StderrLineTransform}, so that each\n * {@link ITerminalChunk.text} item is a single line terminated by a `\"\\n\"` character.\n *\n * The {@link IStdioSummarizerOptions.leadingLines} and {@link IStdioSummarizerOptions.trailingLines}\n * counts specify the maximum number of lines to be returned. Any additional lines will be omitted.\n * For example, if `leadingLines` and `trailingLines` were set to `3`, then the summary of 16 `stderr` lines might\n * look like this:\n *\n * ```\n * Line 1\n * Line 2\n * Line 3\n *   ...10 lines omitted...\n * Line 14\n * Line 15\n * Line 16\n * ```\n *\n * If the `stderr` output is completely empty, then the `stdout` output will be summarized instead.\n *\n * @beta\n */\nexport class StdioSummarizer extends TerminalWritable {\n  // Capture up to this many leading lines\n  private _leadingLines: number;\n\n  // Capture up to this many trailing lines\n  private _trailingLines: number;\n\n  private readonly _abridgedLeading: string[];\n  private readonly _abridgedTrailing: string[];\n  private _abridgedOmittedLines: number = 0;\n  private _abridgedStderr: boolean;\n\n  public constructor(options?: IStdioSummarizerOptions) {\n    super(options);\n\n    if (!options) {\n      options = {};\n    }\n\n    this._leadingLines = options.leadingLines !== undefined ? options.leadingLines : 10;\n    this._trailingLines = options.trailingLines !== undefined ? options.trailingLines : 10;\n\n    this._abridgedLeading = [];\n    this._abridgedTrailing = [];\n    this._abridgedStderr = false;\n  }\n\n  /**\n   * Returns the summary report.\n   *\n   * @remarks\n   * The `close()` method must be called before `getReport()` can be used.\n   */\n  public getReport(): string {\n    if (this.isOpen) {\n      throw new Error('The summary cannot be prepared until after close() is called.');\n    }\n    const report: string[] = [...this._abridgedLeading];\n    if (this._abridgedOmittedLines === 1) {\n      report.push(`  ...${this._abridgedOmittedLines} line omitted...\\n`);\n    }\n    if (this._abridgedOmittedLines > 1) {\n      report.push(`  ...${this._abridgedOmittedLines} lines omitted...\\n`);\n    }\n    report.push(...this._abridgedTrailing);\n    return report.join('');\n  }\n\n  public onWriteChunk(chunk: ITerminalChunk): void {\n    if (chunk.text.length === 0 || chunk.text[chunk.text.length - 1] !== '\\n') {\n      throw new Error(\n        'StdioSummarizer expects chunks that were separated parsed into lines by StderrLineTransform\\n' +\n          ' Invalid input: ' +\n          JSON.stringify(chunk.text)\n      );\n    }\n\n    if (chunk.kind === TerminalChunkKind.Stderr && !this._abridgedStderr) {\n      // The first time we see stderr, switch to capturing stderr\n      this._abridgedStderr = true;\n      this._abridgedLeading.length = 0;\n      this._abridgedTrailing.length = 0;\n      this._abridgedOmittedLines = 0;\n    } else if (this._abridgedStderr && chunk.kind !== TerminalChunkKind.Stderr) {\n      // If we're capturing stderr, then ignore non-stderr input\n      return;\n    }\n\n    // Did we capture enough leading lines?\n    if (this._abridgedLeading.length < this._leadingLines) {\n      this._abridgedLeading.push(chunk.text);\n      return;\n    }\n\n    this._abridgedTrailing.push(chunk.text);\n\n    // If we captured to many trailing lines, omit the extras\n    while (this._abridgedTrailing.length > this._trailingLines) {\n      this._abridgedTrailing.shift();\n      ++this._abridgedOmittedLines;\n    }\n  }\n}\n"]}

package/lib-esm/StdioWritable.js

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import process from 'node:process';
+import { TerminalChunkKind } from './ITerminalChunk';
+import { TerminalWritable } from './TerminalWritable';
+/**
+ * A {@link TerminalWritable} subclass that writes its output directly to the process `stdout` and `stderr`
+ * streams.
+ *
+ * @remarks
+ * This is the standard output target for a process.  You normally do not need to construct
+ * this class; the {@link StdioWritable."instance"} singleton can be used instead.
+ *
+ * @public
+ */
+export class StdioWritable extends TerminalWritable {
+    onWriteChunk(chunk) {
+        if (chunk.kind === TerminalChunkKind.Stdout) {
+            process.stdout.write(chunk.text);
+        }
+        else if (chunk.kind === TerminalChunkKind.Stderr) {
+            process.stderr.write(chunk.text);
+        }
+    }
+}
+StdioWritable.instance = new StdioWritable();
+//# sourceMappingURL=StdioWritable.js.map

package/lib-esm/StdioWritable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StdioWritable.js","sourceRoot":"","sources":["../src/StdioWritable.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC,OAAO,EAAuB,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAc,SAAQ,gBAAgB;IAGvC,YAAY,CAAC,KAAqB;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;YAC5C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;YACnD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;;AARa,sBAAQ,GAAkB,IAAI,aAAa,EAAE,CAAC","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 process from 'node:process';\n\nimport { type ITerminalChunk, TerminalChunkKind } from './ITerminalChunk';\nimport { TerminalWritable } from './TerminalWritable';\n\n/**\n * A {@link TerminalWritable} subclass that writes its output directly to the process `stdout` and `stderr`\n * streams.\n *\n * @remarks\n * This is the standard output target for a process.  You normally do not need to construct\n * this class; the {@link StdioWritable.\"instance\"} singleton can be used instead.\n *\n * @public\n */\nexport class StdioWritable extends TerminalWritable {\n  public static instance: StdioWritable = new StdioWritable();\n\n  protected onWriteChunk(chunk: ITerminalChunk): void {\n    if (chunk.kind === TerminalChunkKind.Stdout) {\n      process.stdout.write(chunk.text);\n    } else if (chunk.kind === TerminalChunkKind.Stderr) {\n      process.stderr.write(chunk.text);\n    }\n  }\n}\n"]}

package/lib-esm/StringBufferTerminalProvider.js

@@ -0,0 +1,185 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { StringBuilder, Text } from '@rushstack/node-core-library';
+import { TerminalProviderSeverity } from './ITerminalProvider';
+import { AnsiEscape } from './AnsiEscape';
+function _normalizeOptions(options) {
+    return {
+        normalizeSpecialCharacters: true,
+        ...options
+    };
+}
+function _normalizeOutput(s, options) {
+    const { normalizeSpecialCharacters } = _normalizeOptions(options !== null && options !== void 0 ? options : {});
+    return _normalizeOutputInner(s, normalizeSpecialCharacters);
+}
+function _normalizeOutputInner(s, normalizeSpecialCharacters) {
+    s = Text.convertToLf(s);
+    if (normalizeSpecialCharacters) {
+        return AnsiEscape.formatForTests(s, { encodeNewlines: true });
+    }
+    else {
+        return s;
+    }
+}
+const LONGEST_SEVERITY_NAME_LENGTH = Object.keys(TerminalProviderSeverity).reduce((max, k) => Math.max(max, k.length), 0);
+/**
+ * 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 StringBufferTerminalProvider {
+    constructor(supportsColor = false) {
+        this._standardBuffer = new StringBuilder();
+        this._verboseBuffer = new StringBuilder();
+        this._debugBuffer = new StringBuilder();
+        this._warningBuffer = new StringBuilder();
+        this._errorBuffer = new StringBuilder();
+        this._allOutputChunks = [];
+        this.supportsColor = supportsColor;
+    }
+    /**
+     * {@inheritDoc ITerminalProvider.write}
+     */
+    write(text, severity) {
+        const severityName = TerminalProviderSeverity[severity];
+        const lastChunk = this._allOutputChunks[this._allOutputChunks.length - 1];
+        if (lastChunk && lastChunk.severity === severityName) {
+            lastChunk.text += text;
+        }
+        else {
+            this._allOutputChunks.push({
+                text,
+                severity: severityName
+            });
+        }
+        switch (severity) {
+            case TerminalProviderSeverity.warning: {
+                this._warningBuffer.append(text);
+                break;
+            }
+            case TerminalProviderSeverity.error: {
+                this._errorBuffer.append(text);
+                break;
+            }
+            case TerminalProviderSeverity.verbose: {
+                this._verboseBuffer.append(text);
+                break;
+            }
+            case TerminalProviderSeverity.debug: {
+                this._debugBuffer.append(text);
+                break;
+            }
+            case TerminalProviderSeverity.log:
+            default: {
+                this._standardBuffer.append(text);
+                break;
+            }
+        }
+    }
+    /**
+     * {@inheritDoc ITerminalProvider.eolCharacter}
+     */
+    get eolCharacter() {
+        return '\n';
+    }
+    /**
+     * Get everything that has been written at log-level severity.
+     */
+    getOutput(options) {
+        return _normalizeOutput(this._standardBuffer.toString(), options);
+    }
+    /**
+     * @deprecated - use {@link StringBufferTerminalProvider.getVerboseOutput}
+     */
+    getVerbose(options) {
+        return this.getVerboseOutput(options);
+    }
+    /**
+     * Get everything that has been written at verbose-level severity.
+     */
+    getVerboseOutput(options) {
+        return _normalizeOutput(this._verboseBuffer.toString(), options);
+    }
+    /**
+     * Get everything that has been written at debug-level severity.
+     */
+    getDebugOutput(options) {
+        return _normalizeOutput(this._debugBuffer.toString(), options);
+    }
+    /**
+     * Get everything that has been written at error-level severity.
+     */
+    getErrorOutput(options) {
+        return _normalizeOutput(this._errorBuffer.toString(), options);
+    }
+    /**
+     * Get everything that has been written at warning-level severity.
+     */
+    getWarningOutput(options) {
+        return _normalizeOutput(this._warningBuffer.toString(), options);
+    }
+    getAllOutput(sparse, options) {
+        const result = {};
+        const log = this.getOutput(options);
+        if (!sparse || log) {
+            result.log = log;
+        }
+        const warning = this.getWarningOutput(options);
+        if (!sparse || warning) {
+            result.warning = warning;
+        }
+        const error = this.getErrorOutput(options);
+        if (!sparse || error) {
+            result.error = error;
+        }
+        const verbose = this.getVerboseOutput(options);
+        if (!sparse || verbose) {
+            result.verbose = verbose;
+        }
+        const debug = this.getDebugOutput(options);
+        if (!sparse || debug) {
+            result.debug = debug;
+        }
+        return result;
+    }
+    getAllOutputAsChunks(options = {}) {
+        const { asLines, normalizeSpecialCharacters } = _normalizeOptions(options);
+        if (asLines) {
+            const lines = [];
+            for (const { text: rawText, severity: rawSeverity } of this._allOutputChunks) {
+                const severity = rawSeverity.padStart(LONGEST_SEVERITY_NAME_LENGTH, ' ');
+                const lfText = Text.convertToLf(rawText);
+                const rawLines = lfText.split('\n');
+                // Emit one entry per logical line.
+                for (let i = 0; i < rawLines.length; i++) {
+                    const isLast = i === rawLines.length - 1;
+                    const isFinalTrailingEmpty = isLast && rawLines[i] === '';
+                    if (isFinalTrailingEmpty) {
+                        continue;
+                    }
+                    const hasNewlineAfter = i < rawLines.length - 1;
+                    // If the original output had a newline after this line, preserve it as the special token
+                    // (e.g. "[n]") when normalization is enabled.
+                    const shouldIncludeNewlineToken = normalizeSpecialCharacters && hasNewlineAfter;
+                    const lineText = shouldIncludeNewlineToken ? `${rawLines[i]}\n` : rawLines[i];
+                    const text = _normalizeOutputInner(lineText, normalizeSpecialCharacters);
+                    lines.push(`[${severity}] ${text}`);
+                }
+            }
+            return lines;
+        }
+        else {
+            return this._allOutputChunks.map(({ text: rawText, severity }) => {
+                const text = _normalizeOutputInner(rawText, normalizeSpecialCharacters);
+                return {
+                    text,
+                    severity
+                };
+            });
+        }
+    }
+}
+//# sourceMappingURL=StringBufferTerminalProvider.js.map