Go: Update tags for high precision quality queries #19763
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
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes and expands the classification tags on Go QL queries for higher-precision code quality checks.
- Adds or reorders tags (e.g., quality, reliability, correctness, useless-code, error-handling, readability) across multiple queries
- Ensures each high-precision rule is properly classified under CWE and project-specific categories
Reviewed Changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| go/ql/src/RedundantCode/SelfAssignment.ql | Expanded tags to quality, reliability, and correctness |
| go/ql/src/RedundantCode/RedundantRecover.ql | Replaced tags with quality, maintability, useless-code |
| go/ql/src/RedundantCode/RedundantExpr.ql | Added quality and reliability tags |
| go/ql/src/RedundantCode/NegativeLengthCheck.ql | Added quality, reliability, and correctness |
| go/ql/src/RedundantCode/ImpossibleInterfaceNilCheck.ql | Added quality, reliability, correctness, CWE tag |
| go/ql/src/RedundantCode/ExprHasNoEffect.ql | Replaced tags with quality, maintainability, useless-code |
| go/ql/src/RedundantCode/DuplicateSwitchCase.ql | Changed maintainability to quality and added reliability |
| go/ql/src/RedundantCode/DuplicateCondition.ql | Changed maintainability to quality and added reliability |
| go/ql/src/RedundantCode/DuplicateBranches.ql | Changed maintainability to quality and added reliability |
| go/ql/src/RedundantCode/DeadStoreOfLocal.ql | Replaced maintainability with quality and useless-code |
| go/ql/src/RedundantCode/DeadStoreOfField.ql | Replaced maintainability with quality and useless-code |
| go/ql/src/RedundantCode/CompareIdenticalValues.ql | Added quality and reliability tags |
| go/ql/src/InconsistentCode/WrappedErrorAlwaysNil.ql | Replaced reliability with quality and reliability tags |
| go/ql/src/InconsistentCode/WhitespaceContradictsPrecedence.ql | Replaced maintainability/correctness with quality and readability |
| go/ql/src/InconsistentCode/UnhandledCloseWritableHandle.ql | Replaced multiple old tags with quality, reliability, error-handling |
| go/ql/src/InconsistentCode/MistypedExponentiation.ql | Added quality, reliability, and correctness tags |
| go/ql/src/InconsistentCode/MissingErrorCheck.ql | Replaced old tags with quality, reliability, error-handling |
| go/ql/src/InconsistentCode/LengthComparisonOffByOne.ql | Replaced reliability with quality and reliability tags |
| go/ql/src/InconsistentCode/InconsistentLoopOrientation.ql | Added quality, reliability, and correctness tags |
| go/ql/src/InconsistentCode/ConstantLengthComparison.ql | Added quality, reliability, and correctness tags |
Comments suppressed due to low confidence (2)
go/ql/src/InconsistentCode/WrappedErrorAlwaysNil.ql:7
- This query detects an error-wrapping scenario; consider adding
error-handlingto its tags so that consumers can easily filter by error-related checks.
* @tags quality
go/ql/src/RedundantCode/DuplicateBranches.ql:7
- The
@idfield appears after@precisionhere; swapping them (ID before precision) would align this file with the metadata order used elsewhere in the repo.
* @precision very-high
| * @tags maintainability | ||
| * correctness | ||
| * quality | ||
| * @tags quality |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
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.
Updated tags for high and very high precision quality queries, using the query metadata guide. It is intended that all of these queries will now be in the quality suite.
I used copilot to do most of these, though I did review them all and change some.
Something that came up several times is a query that finds what is probably a coding mistake which leads to dead code. I erred on the side of tagging these as
correctness(or sometimeserror-handling) rather thanuseless-code, as the more serious issue is that the code probably contains a correctness error, rather than that there is some useless code that should be deleted.