feat: config loader, PR formatter, VS Code diagnostics, and SARIF/JSON CLI output#616
Open
Nimatstar wants to merge 4 commits into
Open
Conversation
|
@Nimatstar Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Implements four assigned GasGuard features on one branch.
#592 —
.gasguardrcconfig loaderAdds
src/config/config.interface.tsandsrc/config/config-loader.ts: loads.gasguardrc,.gasguardrc.json, and.gasguardrc.yaml/.yml, supportingignoreRules,includePaths,excludePaths, andseverityThreshold, and falling back to defaults when no file is present.isPathExcluded()lets the scanner skip excluded paths during AST parsing. YAML is parsed by a tiny built-in reader for the flat config shape, so no new dependency is added.#591 — GitHub PR comment formatter
Adds
packages/formatters/src/github-pr-formatter.ts: renders diagnostics into a GitHub-flavored Markdown table (File,Line,Rule,Gas Impact,Suggested Fix), wraps large reports in a collapsible<details>block, and computes aggregate potential gas savings across the changeset.#590 — VS Code inline diagnostics
Adds
packages/vscode-extension/src/diagnostics.tsandextension.ts: binds avscode.languages.createDiagnosticCollection('gasguard'), maps rule matches tovscode.Diagnosticranges atWarningseverity (so squiggly underlines appear in.sol/.rsfiles), and surfaces the estimated gas saving in the hover message.#589 — CLI JSON and SARIF output
Adds
apps/cli/src/formatters/sarif-formatter.ts(mapsRuleMatchobjects to SARIF v2.1.0) andapps/cli/src/commands/scan.tswith--format(text|json|sarif) and--output <file>handling, so results can feed GitHub code scanning and CI dashboards.Unit tests are included for the config loader, PR formatter, and SARIF formatter.
closes #592
closes #591
closes #590
closes #589