[terminal] Add a getAllOutputAsChunks function to StringBufferTerminalProvider that returns an array of chunks that were written to the terminal provider.

common/changes/@microsoft/rush/main_2026-01-04-02-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@rushstack/heft-config-file/main_2026-01-04-02-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-config-file",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/heft-config-file"
+}

common/changes/@rushstack/localization-utilities/main_2026-01-04-02-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/localization-utilities",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/localization-utilities"
+}

common/changes/@rushstack/operation-graph/main_2026-01-04-02-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/operation-graph",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/operation-graph"
+}

common/changes/@rushstack/terminal/main_2026-01-04-00-39.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/terminal",
+      "comment": "Add a `getAllOutputAsChunks` function to `StringBufferTerminalProvider` that returns an array of chunks that were written to the terminal provider.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/terminal"
+}

common/reviews/api/terminal.api.md

@@ -151,6 +151,14 @@ export interface INormalizeNewlinesTextRewriterOptions {
     newlineKind: NewlineKind;
 }
 
+// @beta (undocumented)
+export interface IOutputChunk {
+    // (undocumented)
+    severity: TerminalProviderSeverityName;
+    // (undocumented)
+    text: string;
+}
+
 // @beta (undocumented)
 export type IPrefixProxyTerminalProviderOptions = IStaticPrefixProxyTerminalProviderOptions | IDynamicPrefixProxyTerminalProviderOptions;
 
@@ -192,9 +200,14 @@ export interface IStdioSummarizerOptions extends ITerminalWritableOptions {
     trailingLines?: number;
 }
 
+// @beta (undocumented)
+export interface IStringBufferOutputChunksOptions extends IStringBufferOutputOptions {
+    asLines?: boolean;
+}
+
 // @beta (undocumented)
 export interface IStringBufferOutputOptions {
-    normalizeSpecialCharacters: boolean;
+    normalizeSpecialCharacters?: boolean;
 }
 
 // @beta (undocumented)
@@ -381,6 +394,13 @@ export class StringBufferTerminalProvider implements ITerminalProvider {
     getAllOutput(sparse?: false, options?: IStringBufferOutputOptions): IAllStringBufferOutput;
     // (undocumented)
     getAllOutput(sparse: true, options?: IStringBufferOutputOptions): Partial<IAllStringBufferOutput>;
+    getAllOutputAsChunks(options?: IStringBufferOutputChunksOptions & {
+        asLines?: false;
+    }): IOutputChunk[];
+    // (undocumented)
+    getAllOutputAsChunks(options: IStringBufferOutputChunksOptions & {
+        asLines: true;
+    }): `[${string}] ${string}`[];
     getDebugOutput(options?: IStringBufferOutputOptions): string;
     getErrorOutput(options?: IStringBufferOutputOptions): string;
     getOutput(options?: IStringBufferOutputOptions): string;
@@ -389,7 +409,7 @@ export class StringBufferTerminalProvider implements ITerminalProvider {
     getVerboseOutput(options?: IStringBufferOutputOptions): string;
     getWarningOutput(options?: IStringBufferOutputOptions): string;
     readonly supportsColor: boolean;
-    write(data: string, severity: TerminalProviderSeverity): void;
+    write(text: string, severity: TerminalProviderSeverity): void;
 }
 
 // @beta
@@ -429,6 +449,9 @@ export enum TerminalProviderSeverity {
     warning = 1
 }
 
+// @beta (undocumented)
+export type TerminalProviderSeverityName = keyof typeof TerminalProviderSeverity;
+
 // @beta
 export class TerminalStreamWritable extends Writable {
     constructor(options: ITerminalStreamWritableOptions);

libraries/heft-config-file/src/test/ConfigurationFile.test.ts

@@ -26,7 +26,7 @@ describe('ConfigurationFile', () => {
   });
 
   afterEach(() => {
-    expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+    expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
   });
 
   describe('A simple config file', () => {

libraries/localization-utilities/src/parsers/test/__snapshots__/parseResx.test.ts.snap

@@ -22,7 +22,7 @@ Array [
 ]
 `;
 
-exports[`parseResx correctly ignores a string: terminal output 1`] = `Object {}`;
+exports[`parseResx correctly ignores a string: terminal output 1`] = `Array []`;
 
 exports[`parseResx fails to parse a RESX file with a duplicate string: Loc file 1`] = `
 Object {
@@ -34,9 +34,9 @@ Object {
 `;
 
 exports[`parseResx fails to parse a RESX file with a duplicate string: terminal output 1`] = `
-Object {
-  "error": "test.resx(6,45): Duplicate string value \\"stringA\\"[n]",
-}
+Array [
+  "[  error] test.resx(6,45): Duplicate string value \\"stringA\\"[n]",
+]
 `;
 
 exports[`parseResx ignoreMissingResxComments when set to false, warns on a missing comment: Loc file 1`] = `
@@ -49,9 +49,9 @@ Object {
 `;
 
 exports[`parseResx ignoreMissingResxComments when set to false, warns on a missing comment: terminal output 1`] = `
-Object {
-  "warning": "test.resx(3,59): Missing string comment in <data> element[n]",
-}
+Array [
+  "[warning] test.resx(3,59): Missing string comment in <data> element[n]",
+]
 `;
 
 exports[`parseResx ignoreMissingResxComments when set to true, ignores a missing comment: Loc file 1`] = `
@@ -63,7 +63,7 @@ Object {
 }
 `;
 
-exports[`parseResx ignoreMissingResxComments when set to true, ignores a missing comment: terminal output 1`] = `Object {}`;
+exports[`parseResx ignoreMissingResxComments when set to true, ignores a missing comment: terminal output 1`] = `Array []`;
 
 exports[`parseResx ignoreMissingResxComments when set to undefined, warns on a missing comment: Loc file 1`] = `
 Object {
@@ -74,7 +74,7 @@ Object {
 }
 `;
 
-exports[`parseResx ignoreMissingResxComments when set to undefined, warns on a missing comment: terminal output 1`] = `Object {}`;
+exports[`parseResx ignoreMissingResxComments when set to undefined, warns on a missing comment: terminal output 1`] = `Array []`;
 
 exports[`parseResx parses a valid file with a schema: Loc file 1`] = `
 Object {
@@ -89,7 +89,7 @@ Object {
 }
 `;
 
-exports[`parseResx parses a valid file with a schema: terminal output 1`] = `Object {}`;
+exports[`parseResx parses a valid file with a schema: terminal output 1`] = `Array []`;
 
 exports[`parseResx parses a valid file with quotemarks: Loc file 1`] = `
 Object {
@@ -100,7 +100,7 @@ Object {
 }
 `;
 
-exports[`parseResx parses a valid file with quotemarks: terminal output 1`] = `Object {}`;
+exports[`parseResx parses a valid file with quotemarks: terminal output 1`] = `Array []`;
 
 exports[`parseResx prints an error on invalid XML: Loc file 1`] = `
 Object {
@@ -112,9 +112,9 @@ Object {
 `;
 
 exports[`parseResx prints an error on invalid XML: terminal output 1`] = `
-Object {
-  "error": "test.resx(3,41): Found unexpected non-empty text node in RESX <data> element[n]",
-}
+Array [
+  "[  error] test.resx(3,41): Found unexpected non-empty text node in RESX <data> element[n]",
+]
 `;
 
 exports[`parseResx resxNewlineNormalization when set to CrLf, normalizes to CrLf: Loc file 1`] = `
@@ -128,7 +128,7 @@ Object {
 }
 `;
 
-exports[`parseResx resxNewlineNormalization when set to CrLf, normalizes to CrLf: terminal output 1`] = `Object {}`;
+exports[`parseResx resxNewlineNormalization when set to CrLf, normalizes to CrLf: terminal output 1`] = `Array []`;
 
 exports[`parseResx resxNewlineNormalization when set to Lf, normalizes to Lf: Loc file 1`] = `
 Object {
@@ -141,4 +141,4 @@ Object {
 }
 `;
 
-exports[`parseResx resxNewlineNormalization when set to Lf, normalizes to Lf: terminal output 1`] = `Object {}`;
+exports[`parseResx resxNewlineNormalization when set to Lf, normalizes to Lf: terminal output 1`] = `Array []`;

libraries/localization-utilities/src/parsers/test/parseResx.test.ts

@@ -16,7 +16,7 @@ describe(parseResx.name, () => {
   });
 
   afterEach(() => {
-    expect(terminalProvider.getAllOutput(true)).toMatchSnapshot('terminal output');
+    expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot('terminal output');
   });
 
   async function testResxAsync(

libraries/operation-graph/src/test/OperationExecutionManager.test.ts

@@ -68,7 +68,7 @@ describe(OperationExecutionManager.name, () => {
         });
 
         expect(result).toBe(OperationStatus.NoOp);
-        expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+        expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
       });
 
       it('handles trivial input', async () => {
@@ -87,7 +87,7 @@ describe(OperationExecutionManager.name, () => {
         });
 
         expect(result).toBe(OperationStatus.Success);
-        expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+        expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
 
         expect(operation.state?.status).toBe(OperationStatus.NoOp);
       });
@@ -135,7 +135,7 @@ describe(OperationExecutionManager.name, () => {
         });
 
         expect(result).toBe(OperationStatus.Success);
-        expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+        expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
 
         expect(runAlpha).toHaveBeenCalledTimes(1);
         expect(runBeta).toHaveBeenCalledTimes(1);
@@ -187,7 +187,7 @@ describe(OperationExecutionManager.name, () => {
         });
 
         expect(result).toBe(OperationStatus.Failure);
-        expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+        expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
         expect(runAlpha).toHaveBeenCalledTimes(1);
         expect(runBeta).toHaveBeenCalledTimes(0);
 
@@ -218,7 +218,7 @@ describe(OperationExecutionManager.name, () => {
         });
 
         expect(result).toBe(OperationStatus.NoOp);
-        expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+        expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
       });
 
       it('respects priority order', async () => {
@@ -271,7 +271,7 @@ describe(OperationExecutionManager.name, () => {
         expect(executed).toEqual([beta, alpha]);
 
         expect(result).toBe(OperationStatus.Success);
-        expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+        expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
 
         expect(runAlpha).toHaveBeenCalledTimes(1);
         expect(runBeta).toHaveBeenCalledTimes(1);
@@ -324,7 +324,7 @@ describe(OperationExecutionManager.name, () => {
         });
 
         expect(result).toBe(OperationStatus.Success);
-        expect(terminalProvider.getAllOutput(true)).toMatchSnapshot();
+        expect(terminalProvider.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot();
 
         expect(run).toHaveBeenCalledTimes(2);
 
@@ -391,7 +391,7 @@ describe(OperationExecutionManager.name, () => {
         expect(betaRequestRun).toBeDefined();
 
         expect(result1).toBe(OperationStatus.Success);
-        expect(terminalProvider1.getAllOutput(true)).toMatchSnapshot('first');
+        expect(terminalProvider1.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot('first');
 
         expect(runAlpha).toHaveBeenCalledTimes(1);
         expect(runBeta).toHaveBeenCalledTimes(1);
@@ -423,7 +423,7 @@ describe(OperationExecutionManager.name, () => {
         });
 
         expect(result2).toBe(OperationStatus.Success);
-        expect(terminalProvider2.getAllOutput(true)).toMatchSnapshot('second');
+        expect(terminalProvider2.getAllOutputAsChunks({ asLines: true })).toMatchSnapshot('second');
 
         expect(runAlpha).toHaveBeenCalledTimes(2);
         expect(runBeta).toHaveBeenCalledTimes(2);