Allow autocorrect with display-only-fail-level-offenses #12535
Conversation
naveg
force-pushed
the
naveg/autocorrect-display-fail
branch
from
0024ae9
to
6416464
Compare
naveg
force-pushed
the
naveg/autocorrect-display-fail
branch
2 times, most recently
from
668c50b
to
23e65ab
Compare
| it 'fails if given with an autocorrect argument' do | ||
| %w[--fix-layout -x --autocorrect -a --autocorrect-all -A].each do |o| | ||
| expect { options.parse ['--display-only-correctable', o] } | ||
| .to raise_error(RuboCop::OptionArgumentError) |
There was a problem hiding this comment.
It seems that instead of being removed, it should be updated to reflect an expected behavior, rather than resulting in the RuboCop::OptionArgumentError error.
There was a problem hiding this comment.
I'm not sure I follow. This tests the validation that I removed in order to allow the two arguments to be used together. I could change it to not_to expect the error, but did you have something else in mind?
There was a problem hiding this comment.
Yeah, for now, the test should probably be changed to not_to.
There was a problem hiding this comment.
Done. The test was actually not doing the right thing before, because it was re-using the same Options instance and generating errors for a different reason (using -a and -A together)
The `--display-only-fail-level-offenses` option uses `considered_failure?` to determine what to print. The same method is used to determine the exit code of `rubocop`, so the two options should be entirely safe to use together. This change is useful when using rubocop as part of a pre-commit hook. When the hook fails becuase rubocop exited with a non-zero status, we can use `--display-only-fail-level-offenses` to avoid having the output cluttered up with non-blocking offenses.
naveg
force-pushed
the
naveg/autocorrect-display-fail
branch
from
23e65ab
to
b695ff7
Compare
|
@koic would appreciate another look when you have a chance, thanks! 🙏 |
|
The change looks good to me. Thanks! |
The
--display-only-fail-level-offensesoption usesconsidered_failure?to determine what to print. The same method isused to determine the exit code of
rubocop, so the two options shouldbe entirely safe to use together.
This change is useful when using rubocop as part of a pre-commit hook.
When the hook fails becuase rubocop exited with a non-zero status, we
can use
--display-only-fail-level-offensesto avoid having the outputcluttered up with non-blocking offenses.
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.