fix: correct CLI flag in README and use package version in SARIF output#7
Closed
dmchaledev wants to merge 1 commit into
Closed
fix: correct CLI flag in README and use package version in SARIF output#7dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
- Fix README: --output=sarif → --format=sarif (the actual CLI flag) - Replace hardcoded '0.0.1' version in toSarif() with version from package.json - Update tsconfig to include resolveJsonModule for JSON imports - Update sarif test to expect actual package version '1.0.1' Before this fix, SARIF consumers would always see tool version '0.0.1' regardless of the actual package version being used.
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
1 participant
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
Two bugs fixed in this PR:
1. Wrong CLI flag in README
The README showed
--output=sarifbut the actual flag is--format=sarif. Users following the docs would get an error.2. Hardcoded version in SARIF output
toSarif()always reported version"0.0.1"regardless of the actual package version. This caused SARIF consumers (GitHub Code Scanning, etc.) to see stale version metadata.package.jsonversion viacreateRequireresolveJsonModuleto tsconfig"1.0.1"Verification
npm run build— passesnpm test— 70/70 tests passnpm run lint— passes (0 warnings)