Update auto-gen-config's comment re auto-correct for SafeAutoCorrect: false
#10673
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
ydah
force-pushed
the
auto_gen_config_unsafe
branch
from
d4d4c1d
to
2b9a91f
Compare
nobuyo
reviewed
May 26, 2022
ydah
force-pushed
the
auto_gen_config_unsafe
branch
from
2b9a91f
to
89d0636
Compare
|
The method names |
ydah
force-pushed
the
auto_gen_config_unsafe
branch
from
89d0636
to
2dd53d0
Compare
Indeed it is. I've standardized on |
nobuyo
reviewed
May 27, 2022
ydah
force-pushed
the
auto_gen_config_unsafe
branch
2 times, most recently
from
e519ace
to
b8d72f9
Compare
nobuyo
reviewed
May 27, 2022
…: false` This PR is enhancement: rubocop#10384 The auto-gen-config output will say "Cop supports --auto-correct". However, Cop with `SafeAutoCorrect: false` outputs the same as follows: ```yaml # This cop supports safe auto-correction (--auto-correct). # Configuration parameters: EnforcedStyle. # SupportedStyles: always, always_true, never Style/FrozenStringLiteralComment: ``` We'll want to execute the following commands when we see it. ``` bundle exec rubocop --auto-correct foo.rb ``` However, it is not automatically corrected. ``` Offenses: foo.rb:1:1: C: [Correctable] Style/FrozenStringLiteralComment: Missing frozen string literal comment. [2, 1, 3].sort.first ^ 1 file inspected, 5 offenses detected, 5 more offenses can be corrected with `rubocop -A` ``` So, we should suggest --auto-correct-all for `SafeAutoCorrect: false` Cop as well.
ydah
force-pushed
the
auto_gen_config_unsafe
branch
from
b8d72f9
to
efca771
Compare
|
Thanks! |
This was referenced Jun 8, 2022
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.
This PR is enhancement: #10384
The auto-gen-config output will say "Cop supports --auto-correct".
However, Cop with
SafeAutoCorrect: falseoutputs the same as follows:We'll want to execute the following commands when we see it.
However, it is not automatically corrected.
So, we should suggest --auto-correct-all for
SafeAutoCorrect: falseCop as well.Before submitting the PR make sure the following are checked:
* [ ] Commit message starts with[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.