The commits in this proposed change do two things:
alphabetize the rules in .rubocop.yml (see commit message ae17887 for details), and
generate a .rubocop_todo.yml file (commit 19ff793's message quoted below for clarity).
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 for .rubocop_todo.yml may be found here:
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/FrozenStringLiteral rule in .rubocop_todo.yml is (among other proposed changes) addressed in #89.
Testing
Pull the latest and git switch rubocop-config-changes.
Description
The commits in this proposed change do two things:
.rubocop.yml
(see commit message ae17887 for details), and.rubocop_todo.yml
file (commit 19ff793's message quoted below for clarity).Documentation for
.rubocop_todo.yml
may 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/FrozenStringLiteral
rule in.rubocop_todo.yml
is (among other proposed changes) addressed in #89.Testing
git switch rubocop-config-changes
.bundle install
if necessary.bundle exec rubocop
and note linting passes!