Skip to content

report --markdown: before/after tables for documenting an intended change - #98

Merged
tmashara merged 1 commit into
mainfrom
claude/issue-27-markdown-export
Oct 30, 2026
Merged

tmashara merged 1 commit into
mainfrom
claude/issue-27-markdown-export

Conversation

@tmashara

Copy link
Copy Markdown
Owner

Fixes #27

renderdiff report <out> --markdown <file> writes, from results.json and without a browser, one ## <route> section per route. Each section has the before (right) and after (left) URLs and a | Width | Before | After | table that links each width's full-page shots, with (h±Npx) when the heights differ and the error message in place of an errored shot.

  • Routes are grouped with Map.groupBy(results, name), as the report sidebar does. Image links come from images.left/right and are made relative to the Markdown file's directory (POSIX separators, encodeURI).
  • --shots-only was dropped. Running with --threshold 0 --no-recheck already skips the exit-1 failure and the right-side reload, and the compare left after that is cheap next to capture. A real shots-only mode would need a new result shape that report.html, evidence.html, --rerun-failed, merge and --accept would all have to handle.
  • Docs: --help and the usage error, README, docs/output.md (## markdown), skill reference.md and SKILL.md.

Verification: npm run typecheck, lint, format:check, npm test (359 pass) and npm run test:visual (389 pass) locally on macOS. A new unit test runs the CLI against a hand-made out dir whose name contains a space. It checks that Before links the right image and After the left, that the height delta appears only on its row, the width order, and the error row.

🤖 Generated with Claude Code

@tmashara
tmashara merged commit aef3927 into main Oct 30, 2026
3 checks passed
@tmashara tmashara mentioned this pull request Oct 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Shots-only mode with a before/after markdown export

1 participant