Reporter overhaul (4/6): opt-in reporters, selection, StreamCollator replacement

[Sean Larkin (TheLarkInn)]

📚 Reporter Overhaul PR stack (merge bottom-up)

#	PR	Phase	Base
1	#5865	Contracts & baselines (package)	main
2	#5866	Bootstrap & compatibility	#5865
3	#5867	Shadow structured emission	#5866
4	#5868	Opt-in reporters	#5867
5	#5869	Heft protocol track	#5868
6	#5870	Perf budgets & default flip	#5869

Each PR's diff is scoped to its phase; review independently, merge from #5865 upward.

👉 This is PR 4 of 6.

Phase 4 — Opt-in reporters (RFC §8.1)

Adds the actual reporters plus selection/config, and replaces StreamCollator only on the new reporter path.

What's included

• Selection & config — reporter selection precedence (--reporter/RUSH_REPORTER/agent/CI/TTY), independent per-reporter log levels, and the automatic environment matrix.
• Reporters — default interactive (3-row live region), plaintext/non-TTY, json, bounded ai, full-detail file (owner-only perms, retention, OS-temp fallback), and legacy (selectable + emergency fallback).
• StreamCollator replacement — raw semantic operation events in the primary output path.
• External output — lossless preservation + diagnostic recovery via problem matchers.
• Legacy error bridge — prohibit new AlreadyReportedError usage; correlate legacy sentinels with emitted diagnostics.

Validation

• rush build --to @rushstack/reporter ✅ rush test --only @rushstack/reporter ✅ (adds ReporterSelection, LogLevelFilter, AutomaticReporterMatrix, the reporter suites, OperationStreamEmitter, ProblemMatchers, LegacyErrorBridge)
• All exports @beta.

Scope note

Standalone package; not yet wired into the live CLI. Independently releasable/revertible per RFC §8.1.

[Copilot]

Pull request overview

Adds standalone opt-in reporter selection, rendering, logging, semantic operation events, problem matching, and legacy compatibility.

Changes:

• Adds environment-based reporter planning and log-level controls.
• Implements interactive, plaintext, JSON, AI, file, and legacy reporters.
• Adds uncollated operation events, diagnostic recovery, and legacy error bridging.

Reviewed changes

Copilot reviewed 51 out of 51 changed files in this pull request and generated 17 comments.

Show a summary per file

File	Description
research/progress.txt	Records phase progress.
research/feature-list.json	Marks phase features complete.
libraries/reporter/src/test/ReporterSelection.test.ts	Tests reporter selection.
libraries/reporter/src/test/ProblemMatchers.test.ts	Tests problem matching.
libraries/reporter/src/test/PlaintextReporter.test.ts	Tests plaintext output.
libraries/reporter/src/test/OperationStreamEmitter.test.ts	Tests semantic event emission.
libraries/reporter/src/test/LogLevelFilter.test.ts	Tests log filtering.
libraries/reporter/src/test/LegacyReporter.test.ts	Tests legacy rendering.
libraries/reporter/src/test/LegacyErrorBridge.test.ts	Tests error bridging.
libraries/reporter/src/test/JsonAiReporter.test.ts	Tests machine reporters.
libraries/reporter/src/test/FileReporter.test.ts	Tests file logging.
libraries/reporter/src/test/DefaultInteractiveReporter.test.ts	Tests interactive rendering.
libraries/reporter/src/test/AutomaticReporterMatrix.test.ts	Tests automatic planning.
libraries/reporter/src/test/__snapshots__/PlaintextReporter.test.ts.snap	Captures plaintext output.
libraries/reporter/src/test/__snapshots__/LegacyReporter.test.ts.snap	Captures legacy output.
libraries/reporter/src/scheduler/OperationStreamEmitter.ts	Emits uncollated operation events.
libraries/reporter/src/scheduler/OperationOutputGrouping.ts	Regroups operation output.
libraries/reporter/src/reporters/ReporterRedaction.ts	Redacts secret fields.
libraries/reporter/src/reporters/PlaintextReporter.ts	Implements plaintext reporting.
libraries/reporter/src/reporters/LegacyReporter.ts	Implements legacy reporting.
libraries/reporter/src/reporters/JsonReporter.ts	Implements NDJSON reporting.
libraries/reporter/src/reporters/InteractiveRendering.ts	Provides live-region helpers.
libraries/reporter/src/reporters/FileReporter.ts	Implements retained file logs.
libraries/reporter/src/reporters/DefaultInteractiveReporter.ts	Implements interactive output.
libraries/reporter/src/reporters/AiReporter.ts	Implements bounded AI output.
libraries/reporter/src/matchers/ProblemMatcherRunner.ts	Recovers diagnostics from output.
libraries/reporter/src/matchers/ProblemMatcherRegistry.ts	Selects applicable matchers.
libraries/reporter/src/matchers/ProblemMatcher.ts	Defines matcher contracts.
libraries/reporter/src/matchers/AnsiNormalization.ts	Normalizes ANSI output.
libraries/reporter/src/index.ts	Exports new APIs.
libraries/reporter/src/diagnostics/templates/operation.ts	Adds external-tool text.
libraries/reporter/src/diagnostics/RushDiagnosticCodeRegistry.ts	Registers external-tool diagnostics.
libraries/reporter/src/config/ReporterSelection.ts	Resolves reporter controls.
libraries/reporter/src/config/ReporterNames.ts	Defines reporter names and levels.
libraries/reporter/src/config/OutputControl.ts	Parses output destinations.
libraries/reporter/src/config/LogLevelFilter.ts	Classifies event visibility.
libraries/reporter/src/config/AutomaticReporterMatrix.ts	Builds environment-specific plans.
libraries/reporter/src/config/AgentDetection.ts	Detects agents and CI.
libraries/reporter/src/compat/LegacyErrorBridge.ts	Correlates legacy sentinels.
common/reviews/api/rush-reporter.api.md	Updates the API report.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-40-55.json	Documents error bridging.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-36-33.json	Documents problem matchers.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-30-02.json	Documents operation events.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-24-04.json	Documents legacy reporting.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-18-53.json	Documents file reporting.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-12-29.json	Documents machine reporters.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-05-03.json	Documents plaintext reporting.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-01-00-00.json	Documents interactive reporting.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-00-50-08.json	Documents reporter planning.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-00-45-15.json	Documents log filtering.
common/changes/@rushstack/rush-reporter/docs-rush-reporter-overhaul-spec_2026-07-15-00-41-00.json	Documents reporter selection.

Suppressed comments (1)

libraries/reporter/src/reporters/AiReporter.ts:312

• After all three arrays are emptied, the record can still exceed maxBytes because commandName, the log path, category/count maps, and other fixed fields remain unbounded. The method then writes the oversized record anyway, violating the documented maximum. Add a final size check and a bounded fallback record or bound the remaining fields.

    for (const target of trimTargets) {
      while (Buffer.byteLength(JSON.stringify(record), 'utf8') > this._maxBytes && target.get().length > 0) {
        target.set(target.get().slice(0, target.get().length - 1));
        record.truncated = true;
      }

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.