[Fix #145] Mark Performance/StringInclude as unsafe
#153
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
Fixes rubocop#145. This PR marks `Performance/StringInclude` as `SafeAutocorrect: false` and disable autocorrect by default. The cop's offenses are not safe to auto-correct if a receiver is nil.
ghiculescu
reviewed
Oct 2, 2020
| @@ -248,6 +248,8 @@ Performance/StartWith: | |||
| Performance/StringInclude: | |||
| Description: 'Use `String#include?` instead of a regex match with literal-only pattern.' | |||
| Enabled: 'pending' | |||
| AutoCorrect: false | |||
There was a problem hiding this comment.
is it okay to leave AutoCorrect: true, as long as SafeAutoCorrect: false?
my understanding is:
AutoCorrect: trueandSafeAutoCorrect: true= autocorrected byrubocop -aorrubocop -AAutoCorrect: trueandSafeAutoCorrect: false= autocorrected byrubocop -AonlyAutoCorrect: falseandSafeAutoCorrect: false= never autocorrectedAutoCorrect: falseandSafeAutoCorrect: true= never autocorrected
Currently this defaults to the third option. Why not the second?
There was a problem hiding this comment.
As it stands, AutoCorrect: false in the default file is reserved for Cops that have corrections that could be useful to some but probably not most people. An example that comes to my mind is LineLength.
This setting should be overriden in .rubocop.yml or via CLI for those that want it
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.
Fixes #145.
This PR marks
Performance/StringIncludeasSafeAutocorrect: falseand disable autocorrect by default. The cop's offenses are not safe to auto-correct if a receiver is nil.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).and description in grammatically correct, complete sentences.
bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.