Skip to content

Allow selective disabling of rules per query #3620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 2, 2024
Merged

Allow selective disabling of rules per query #3620

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d8a8110
Extended the `@sqlc-vet-disable` flag to support the skipping of prov…
rhodeon Sep 28, 2024
28e7e4b
Updated tests to cover new vet disabling behaviour.
rhodeon Sep 28, 2024
5c1546d
Relocated constants for query flags to a dedicated package to allow f…
rhodeon Sep 28, 2024
5b81b1c
Renamed the metadata `ParseParamsAndFlags()` function to `ParseCommen…
rhodeon Sep 28, 2024
bef3dba
Updated docs to reflect the support of rule names for the vet disable…
rhodeon Sep 29, 2024
a82fcb4
Slight term change in vet docs.
rhodeon Sep 29, 2024
474ee13
Renamed test function for query rule skiplist.
rhodeon Sep 29, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Renamed test function for query rule skiplist.
  • Loading branch information
@rhodeon @kyleconroy
rhodeon authored and kyleconroy committed Nov 25, 2024
commit 474ee13f12f7a570ac7524e9c01c1e48fb2c0a4d
16 changes: 8 additions & 8 deletions internal/metadata/meta_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ func TestParseQueryFlags(t *testing.T) {
}
}

func TestParseQueryRuleBlocklist(t *testing.T) {
func TestParseQueryRuleSkiplist(t *testing.T) {
for _, comments := range [][]string{
{
" name: CreateFoo :one",
Expand All @@ -158,7 +158,7 @@ func TestParseQueryRuleBlocklist(t *testing.T) {
" @sqlc-vet-disable delete-without-where ",
},
} {
_, flags, ruleBlocklist, err := ParseCommentFlags(comments)
_, flags, ruleSkiplist, err := ParseCommentFlags(comments)
if err != nil {
t.Errorf("expected comments to parse, got err: %s", err)
}
Expand All @@ -167,16 +167,16 @@ func TestParseQueryRuleBlocklist(t *testing.T) {
t.Errorf("expected @sqlc-vet-disable flag not found")
}

if _, ok := ruleBlocklist["sqlc/db-prepare"]; !ok {
t.Errorf("expected rule not found in blocklist")
if _, ok := ruleSkiplist["sqlc/db-prepare"]; !ok {
t.Errorf("expected rule not found in skiplist")
}

if _, ok := ruleBlocklist["delete-without-where"]; !ok {
t.Errorf("expected rule not found in blocklist")
if _, ok := ruleSkiplist["delete-without-where"]; !ok {
t.Errorf("expected rule not found in skiplist")
}

if _, ok := ruleBlocklist["update-without-where"]; ok {
t.Errorf("unexpected rule found in blocklist")
if _, ok := ruleSkiplist["update-without-where"]; ok {
t.Errorf("unexpected rule found in skiplist")
}
}
}
Loading