chore: add Rubocop configuration file #366
Merged
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.
Short description of what this PR does:
Running
rubocop
locally per the contributing guide resulted in the following:87 files inspected, 2736 offenses detected
But the vast majority of those offense are located in folders excluded by the
.codeclimate.yml
for CI. Excluding those locally yields:40 files inspected, 293 offenses detected
Note: that if someone runs
rubocop -a
to autocorrect issues:40 files inspected, 309 offenses detected, 236 offenses corrected
but this touches 31 files and is likely to result in massive merge conflicts. Best to do after most major feature work is done.
Note: one can run
rubocop --auto-gen-config
and it will generate a.rubocop_todo.yml
file that documents all the spots that need repairing. But it will also change the.rubocop.yml
to inherit the todo file, which then excludes the issues from being reported. Best not commit that.Checklist