radar / humanize

Takes your numbers and makes them *fancy*.
MIT License
468 stars 85 forks source link

Alphabetize RuboCop config, add todo file #91

Closed jgarber623 closed 6 months ago

jgarber623 commented 6 months ago

Description

The commits in this proposed change do two things:

  1. alphabetize the rules in .rubocop.yml (see commit message ae17887 for details), and
  2. 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:

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

  1. Pull the latest and git switch rubocop-config-changes.
  2. bundle install if necessary.
  3. bundle exec rubocop and note linting passes!