Configure RuboCop cops - Githubissues

lostisland / faraday_middleware

Various Faraday middlewares for Faraday-based API wrappers

MIT License

557 stars 203 forks source link

Configure RuboCop cops #256

Closed olleolleolle closed 4 years ago

olleolleolle commented 4 years ago

This Issue is a beginner-friendly issue (it's for you, beginner!), and it's about configuring our use of RuboCop to be as up-to-date as possible.

Background

This project uses RuboCop to keep "code style" in control.

Linting (definition on Wikipedia: lint (software)) gives informative & helpful TODO output in case something is amiss.

In our current situation, we have a TODO:

The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file:
 - Lint/RaiseException (0.81)
 - Lint/StructNewOverride (0.81)
 - Style/HashEachMethods (0.80)
 - Style/HashTransformKeys (0.80)
 - Style/HashTransformValues (0.80)
For more information: https://docs.rubocop.org/en/latest/versioning/

To fix this

add appropriate settings to the .rubocop.yml file
Please set Enabled to either true or false - we want it Enabled: true
ensure no warnings-like informative output happens (e.g. in the RuboCop linting GitHub Actions output)
open a PR which has the keywords Fixes #256 in its Description.

olleolleolle commented 4 years ago

Thanks @kfazinic for taking this on, and contributing a fix!