Alphabetize RuboCop config, add todo file #91
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
As this file grows and without imposing some sort of organization to it, managing `.rubocop.yml` gets really tedious. This change reorganizes the existing file's rules alphabetically.
This commit streamlines the primary `.rubocop.yml` and, using `bundle exec rubocop --auto-gen-config --auto-gen-only-exclude`, generates a ".rubocop_todo.yml" file that can serve as a guide for future refactoring. I've used this file with quite a bit of success on projects. A reasonable goal is that, over time, the file is removed once all issues have either been remediated or a sensible configuration change can be applied to the main `.rubocop.yml` config. Documentation: https://docs.rubocop.org/rubocop/configuration.html#automatically-generated-configuration
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.
Description
The commits in this proposed change do two things:
.rubocop.yml(see commit message ae17887 for details), and.rubocop_todo.ymlfile (commit 19ff793's message quoted below for clarity).Documentation for
.rubocop_todo.ymlmay be found here:https://docs.rubocop.org/rubocop/configuration.html#automatically-generated-configuration
I'd like to take a swing at a few of the "todo" items in the newly-created file. Worth noting, too, that the
Style/FrozenStringLiteralrule in.rubocop_todo.ymlis (among other proposed changes) addressed in #89.Testing
git switch rubocop-config-changes.bundle installif necessary.bundle exec rubocopand note linting passes!