Return global offenses for Style/Copyright when the file is empty
#12804
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
Very similar to rubocop#12802 This adds a check that the returned offenses have a location that formatters can display. While the standard formatter catched the `IndexError`, barely any others did. Since it is not possible to autocorrect global offenses, just don't do that. Adding autocorrect support would be a bunch more work.
|
Thanks! |
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.
Very similar to #12802
This adds a check that the returned offenses have a location that formatters can display. While the standard formatter catched the
IndexError, barely any others did.Since it is not possible to autocorrect global offenses, just don't do that. Adding autocorrect support would be a bunch more work. I've kept autocorrect for cases where the file isn't empty since, while the offense location isn't technically correct, it works.
Note that I removed the catching of
IndexErrorfor the default formatter. Barely any others, except for Tap did that. Formatters like html and markdown would raise when inspecting a empty file withStyle/Copyright.The added extra expectations would have caught the
Style/CopyrightandNaming/FileNamecases, and it also raises forNaming/InclusiveLanguagewith the test modifications I did in my previous PR.If this change is considered too dangerous I can remove it. The added assertions should already be pretty good.
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.