Skip to content

docs(test): move snapshots.toml comment to per-[[e2e]] level#347

Merged
branchseer merged 2 commits intomainfrom
refactor/e2e-per-case-comments
Apr 20, 2026
Merged

docs(test): move snapshots.toml comment to per-[[e2e]] level#347
branchseer merged 2 commits intomainfrom
refactor/e2e-per-case-comments

Conversation

@branchseer
Copy link
Copy Markdown
Member

Summary

  • Drops the file-level comment field from snapshots.toml in the e2e harness; a comment now lives on each [[e2e]] entry and renders under that case's H1 heading.
  • Migrates every existing top-level comment into per-case comments, each written to describe what that individual case verifies (cache behaviors, stdio modes, selector flows, etc.).

Test plan

  • cargo test -p vite_task_bin --test e2e_snapshots passes (148/148 locally)
  • Spot-check a few regenerated .md snapshots to confirm the new comments read sensibly under each H1

🤖 Generated with Claude Code

branchseer and others added 2 commits April 20, 2026 11:05
…] level

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replaces the duplicated file-level text copied across every [[e2e]] entry in
the previous commit with case-specific descriptions that state what each
individual case verifies.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@branchseer branchseer changed the title refactor(test): move snapshots.toml comment to per-[[e2e]] level docs(test): move snapshots.toml comment to per-[[e2e]] level Apr 20, 2026
@branchseer branchseer merged commit 9a71d76 into main Apr 20, 2026
9 checks passed
@branchseer branchseer deleted the refactor/e2e-per-case-comments branch April 20, 2026 03:41
branchseer added a commit that referenced this pull request Apr 20, 2026
… fields

Follows the convention introduced in main (#347): per-`[[e2e]]` and per-
step descriptions use the TOML `comment` field instead of bare `#` lines,
so they render under the snapshot headings and inside each step's block.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.

1 participant