Skip disable line action for self-resolving cops#3945
Open
sucicfilip wants to merge 1 commit intoShopify:mainfrom
Open
Skip disable line action for self-resolving cops#3945sucicfilip wants to merge 1 commit intoShopify:mainfrom
sucicfilip wants to merge 1 commit intoShopify:mainfrom
Conversation
sucicfilip
force-pushed
the
fix/skip-disable-action-for-self-resolving-cops
branch
from
98716c2 to
e0f346c
Compare
sucicfilip
force-pushed
the
fix/skip-disable-action-for-self-resolving-cops
branch
from
e0f346c to
ecac555
Compare
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
1 participant
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.
Motivation
When
Layout/EmptyCommentis reported, the "Disable Layout/EmptyComment for this line" code action adds a# rubocop:disableinline comment, which makes the comment no longer empty, resolving the original offense. This then triggersLint/RedundantCopDisableDirective, so the user ends up in a loop.Implementation
Added a
SELF_RESOLVING_DISABLE_COPSconstant toRuboCopDiagnosticlisting cops where an inline disable would resolve the offense itself. The disable line action is skipped for these cops. Currently only includesLayout/EmptyCommentbut the list can be extended if other similar cases come up.Automated Tests
Added a test in
code_actions_formatting_test.rbthat verifies no disable action is offered forLayout/EmptyComment.Manual Tests
#with nothing after it)Layout/EmptyCommentdiagnostic