feat: first-class PR comment markdown via --pr-comment-output

[aidenybai]

Third and final PR of the #286 split. Stacked on #288 (cursor/baseline-and-touched-lines-675b), which is itself stacked on #287. Merge order: #287 → #288 → this PR.

What's new

--pr-comment-output <path>

react-doctor . --pr-comment --pr-comment-output ./comment.md | tee ./build-log.txt

One scan, two outputs:

• stdout — the legacy --pr-comment plaintext for the build log.
• file — a sticky-PR-comment-ready markdown document written as a side effect.

The action.yml previously had to invoke npx react-doctor@latest twice (once for plaintext, once for markdown). Now it's a single invocation.

buildPrCommentMarkdown(report) — structured rendering

• Leading <!-- react-doctor --> marker so a GitHub Action comment-updater can idempotently replace its previous post.
• Per-rule <details> groups with severity icons, file:line references, and copy-pasteable // eslint-disable-next-line … suppression snippets.
• Per-package summary block for monorepos (worst-scored project drives the headline).
• Baseline-aware framing — "no new violations introduced by this PR" when only baseline issues remain, taken from feat: baseline mode + touched-line enforcement #288's JsonReportSummary.baselineDiagnosticCount.
• Touched-lines footnote when filtering removed diagnostics (consumes feat: baseline mode + touched-line enforcement #288's diagnosticsHiddenByTouchedLines).

action.yml integration

RAW_FILE="${RUNNER_TEMP:-/tmp}/react-doctor-raw-${GITHUB_RUN_ID:-$$}.txt"
set +e
npx react-doctor@latest "$INPUT_DIRECTORY" "${FLAGS[@]}" \
  --pr-comment --pr-comment-output "$MARKDOWN_FILE" | tee "$RAW_FILE"
PIPELINE_EXIT_CODES=("${PIPESTATUS[@]}")
set -e
sed -E '/^::(error|warning) /d' "$RAW_FILE" > "$OUTPUT_FILE"
if [ "${PIPELINE_EXIT_CODES[1]}" -ne 0 ]; then exit "${PIPELINE_EXIT_CODES[1]}"; fi
exit "${PIPELINE_EXIT_CODES[0]}"

The github-script step prefers the markdown file when available; it falls back to the legacy plaintext-in-fence layout when running against older react-doctor versions that don't ship --pr-comment-output.

Stats

• 6 new tests in build-pr-comment-markdown.
• Updated github-action contract tests for the single-scan + PIPESTATUS preservation.
• All 1223 tests passing; lint / typecheck / format clean.

Originally landed as part of #286.

  

[reactreview]

🔴 No new issues

0/100 (unchanged)

^{Reviewed by react-review for commit 18de41d. Configure here.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
react-doctor-website	Ready	Preview, Comment	May 17, 2026 0:16am

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 7d8b50a. Configure here.}