Add invalid-ignore-comment rule
#15094
Merged
Conversation
This file contains 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
MichaReiser
force-pushed
the
micha/unknown-rule
branch
from
f15daa7 to
4879d63
Compare
MichaReiser
force-pushed
the
micha/invalid-ignore-comment
branch
from
07f8973 to
f1764a3
Compare
MichaReiser
requested review from
carljm,
AlexWaygood and
sharkdp
as code owners
MichaReiser
force-pushed
the
micha/unknown-rule
branch
from
4879d63 to
20f346d
Compare
MichaReiser
force-pushed
the
micha/invalid-ignore-comment
branch
from
f1764a3 to
c12eba0
Compare
|
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.
Summary
Red Knot skips over
type: ignoreandknot: ignorecomments that are syntatically incorrect. This can lead to uslesswana be ignore comments lingering in the code base or confusion when users don't understand why their ignore comment doesn't work.
This PR adds a new
invalid-ignore-commentrule that flags ignore comments that are simply incorrect.Design questions
The rule flags invalid
type: ignore[code code]comments even though Red Knot itself ignores the code portion of it. I think this is the correct behavior because Red Knot would ignore an invalidtype: ignorecomment. This way users at least know that Red Knot doesn't understand it. However, there's an argument that we shouldn't be opinionated about ignore comments from other tools.I think the "right" solution is adding an option to configure whether the
unused-ignore-commentandinvalid-ignore-commentshould ignoretype: ignorecomments. If this turns out to be a problem in the future.Test Plan
Added mdtests