Feature: Allow exclusion of lines matching pattern from indentation #4137
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 change allows for more fine-grained control over which lines indentation is required. It isn't frequent, but there are occasionally times when the requirement for indentation doesn't quite fit in with the code style you're trying to achieve.
I wasn't entirely sure on what I wanted to do here, however once I saw the change to the
LineLength
cop which added theIgnoredPatterns
option, I knew that's what I wanted forIndentationWidth
.This PR extracts the
IgnoredPatterns
logic out into a mixin and then adds that to theIndentationWidth
cop.I would recommend reviewing by commit rather than looking at the full diff. The change itself was very minor, however I did a little refactoring to alleviate some rubocop errors.
The end result is that you can have a config like so:
And the following will not throw errors
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.
rake generate_cops_documentation
(required only when you've added a new cop or changed the configuration/documentation of an existing cop).