Update auto-gen-config's comment re auto-correct #10384
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
The auto-gen-config output will say "Cop supports --auto-correct" for cops which do not support --auto-correct, but which do support --auto-correct-all. Let's update the output to reflect that. When someone is working on the todo list, this can be helpful information to have at hand. I'll often run something like: `bin/rubocop --only Style/StringConcatenation -a` and then realize actually that won't work, and this would save me a few seconds.
maxjacobson
commented
Jan 29, 2022
| todo_contents = File.read('.rubocop_todo.yml').lines[8..-1].join | ||
| expect(todo_contents).to eq(<<~YAML) | ||
| # Offense count: 1 | ||
| # Cop supports --auto-correct-all. |
There was a problem hiding this comment.
this line is the relevant assertion. Other examples would say --auto-correct instead of --auto-correct-all
|
I'm fine with the proposed changes, even if I'm starting to get confused by our own terminology. I had forgotten that we made |
8 tasks
|
Thanks for merging! I tend to agree :) #10414 |
7 tasks
ydah
added a commit
to ydah/rubocop
that referenced
this pull request
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.
bbatsov
pushed a commit
that referenced
this pull request
May 31, 2022
…: false` This PR is enhancement: #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.
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.
The auto-gen-config output will say "Cop supports --auto-correct" for
cops which do not support --auto-correct, but which do support
--auto-correct-all. Let's update the output to reflect that. When
someone is working on the todo list, this can be helpful information to
have at hand.
I'll often run something like:
bin/rubocop --only Style/StringConcatenation -aand then realizeactually that won't work, and this would save me a few seconds.
Hi there. This is my first contribution in a few years. Happy to be back. WDYT about this idea?
Unfortunately
bundle exec rake defaultis failing for me locally with this test failure, which is unrelated to my change:Failure
Before submitting the PR make sure the following are checked:
[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.