Skip to content

fix(report): reject unknown --format values and document report formats - #397

Merged
vibgrate-team merged 2 commits into
mainfrom
cursor/report-format-coverage-ede2
Oct 8, 2026
Merged

vibgrate-team merged 2 commits into
mainfrom
cursor/report-format-coverage-ede2

Conversation

@vibgrate-team

Copy link
Copy Markdown
Contributor

Summary

vg report --format only accepts md, text, and json (text is the default). Unknown values such as html used to render the text report and exit 0. They now exit 5 before the artifact is read, write nothing to stdout, and print one stderr line naming the value and the valid ones:

error: unknown --format "html" (expected md, text, json)

DOCS.md now lists what the Markdown and text formatters actually emit, the intentional differences between them, and that json prints the loaded scan artifact unchanged (the only stable machine-readable contract). There is no HTML report.

The agent skill no longer lists sarif as a vg report format. Vendored src/core-open/formatters/ files were left alone — vg report uses src/reporting/formatters/.

Related issues

Closes #268

Checklist

  • pnpm test passes
  • pnpm lint is clean
  • pnpm typecheck is clean
  • Docs updated where behavior changed
  • Determinism preserved
  • No proprietary or internal references
  • Commits use Conventional Commits and are signed off

How to verify

pnpm exec vitest run src/reporting/commands/report.test.ts
pnpm test
pnpm lint
pnpm typecheck

cursoragent and others added 2 commits October 7, 2026 12:06
Unknown values, including html, rendered the text report and exited 0.
Reject them with a usage error that names the value and lists md, text,
and json. Document what the Markdown and text formatters emit, and that
json is the unchanged artifact. There is no HTML report.

Signed-off-by: Cursor Agent <cursoragent@cursor.com>

Co-authored-by: Crowers <crowers@users.noreply.github.com>
@vibgrate-team
vibgrate-team marked this pull request as ready for review October 8, 2026 20:47
@vibgrate-team
vibgrate-team merged commit 814f6f4 into main Oct 8, 2026
1 check passed
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.

Docs: document vg report Markdown vs HTML field coverage

2 participants