feat: implement JSON and SARIF structured output modes#9
Merged
PrasanthYT merged 1 commit intomainfrom Mar 2, 2026
Merged
Conversation
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
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.
Overview
This PR introduces structured output capabilities to Scanr, enabling automation-ready JSON output and SARIF security reporting compatible with GitHub Code Scanning.
This milestone transitions Scanr from a developer CLI into a DevSecOps-compatible security tool.
JSON Output Mode (
--json)CLI Usage
Behavior
Suppresses formatted CLI output
Outputs canonical
ScanResultJSONNo color formatting
No debug logs
Deterministic ordering
Core Model
All core models derive
Serialize.Output can be piped:
SARIF Output (
--sarif)CLI Usage
Behavior
Converts vulnerabilities into SARIF v2.1.0 format
Outputs valid SARIF JSON
Compatible with GitHub Security tab
Severity Mapping
Each result includes:
Rule ID (CVE ID)
Message
Logical location (dependency file path)
Tool metadata:
Name: Scanr
Version
Information URI
Validation
scanr scan . --jsonreturns valid JSONOutput deterministic and machine-readable
SARIF validated against schema
SARIF successfully imports into GitHub Security tab
cargo build --workspace --releasepassesImpact
Enables CI/CD automation
Supports pipeline integration
Compatible with GitHub Code Scanning
Production-grade structured reporting
Increases enterprise adoption readiness
No breaking changes.
🎯 Why This Milestone Matters
This milestone makes Scanr:
Automation-ready
DevSecOps-compatible
CI-native
Enterprise-integrable
It transforms Scanr from a CLI scanner into a security pipeline component.