Allow selective disabling of rules per query #3620
Merged
Conversation
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
rhodeon
force-pushed
the
selectively-disable-rules-per-query
branch
from
90c4935 to
7a16c28
Compare
|
@kyleconroy, can you please confirm if this is something worth having? |
…ided rules. This is an update to the original behaviour which had an "all-or-nothing" behaviour, either running all the rules on a query or skipping them all. Specified rules which aren't declared in the sqlc config file get rejected.
…tFlags()` in order to be more generic as it now returns the rule skip list and could potentially return more data in the future.
kyleconroy
force-pushed
the
selectively-disable-rules-per-query
branch
from
09308a8 to
474ee13
Compare
|
Hey, @kyleconroy. 🫡 |
|
@rhodeon thanks for the updated push. The docs and tests are great! This will go out with the next release. |
alfonsodev
pushed a commit
to ExponentiaTeam/sqlc
that referenced
this pull request
Oct 13, 2025
* Extended the `@sqlc-vet-disable` flag to support the skipping of provided rules. This is an update to the original behaviour which had an "all-or-nothing" behaviour, either running all the rules on a query or skipping them all. Specified rules which aren't declared in the sqlc config file get rejected. * Updated tests to cover new vet disabling behaviour. * Relocated constants for query flags to a dedicated package to allow for safer reuse. * Renamed the metadata `ParseParamsAndFlags()` function to `ParseCommentFlags()` in order to be more generic as it now returns the rule skip list and could potentially return more data in the future. * Updated docs to reflect the support of rule names for the vet disable annotation. * Slight term change in vet docs. * Renamed test function for query rule skiplist.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This resolves #3619 and has some minor refactor in regards to reusable constants.
As mentioned there, the
@sqlc-vet-disablequery annotation now accepts a list of rules to skip:/* @sqlc-vet-disable sqlc/db-prepare no-pg */Providing just
/* @sqlc-vet-disable */without any parameters retains the previous behaviour of skipping all rules for a query.