Repository navigation
fix(report): reject unknown --format values and document report formats - #397
Merged
Merged
Conversation
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
marked this pull request as ready for review
October 8, 2026 20:47
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
vg report --formatonly acceptsmd,text, andjson(textis the default). Unknown values such ashtmlused to render the text report and exit 0. They now exit5before 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.mdnow lists what the Markdown and text formatters actually emit, the intentional differences between them, and thatjsonprints the loaded scan artifact unchanged (the only stable machine-readable contract). There is no HTML report.The agent skill no longer lists
sarifas avg reportformat. Vendoredsrc/core-open/formatters/files were left alone —vg reportusessrc/reporting/formatters/.Related issues
Closes #268
Checklist
pnpm testpassespnpm lintis cleanpnpm typecheckis cleanHow to verify