Captive Rubocop config
Rubocop shared configurations for projects
Install
add the follow line into your Gemfile
group :test, :development do
gem 'rubocop-config-captive', '~> 2.0'
endAnd then in a terminal
$ bundle install
[...]Usage
# /.rubocop.yml
inherit_gem:
rubocop-config-captive:
- config/default.yml
# -OR-
# - config/rubocop-XXX.ymlCommon Errors
Explanation
the configuration is very strict, it is normal to have many errors
Solution
Solution 1 : Auto-correct all errors
bundle exec rubocop -aSolution 2 : Ignore errors and progressively fix them
bundle exec rubocop --auto-gen-configWill create .rubocop_todo.yml will all non passing rules. It is advised to fix them later, rule by rule.
Gemfile has lots of Bundler/GemVersion errors
Explanation
Each dependency should be explicitly set in the Gemfile and bundle update is strongly discouraged.
Solution
Solution 1 : Use bundle-locker
- Install bundle-locker globally
gem install bundle-locker- Pin Gemfile using
Gemfile.lock
bundle-locker ./Gemfile-
Manually edit
Gemfileand adjust constraints"x.x.x","~> x.x.x", etc -
Update
Gemfile.lock
bundle installContributing
To contribute, here are some inspirations for good configurations :
License
MIT © Captive Studio julien.polo@captive.fr
About Captive
rubocop-config-captive is maintained and funded by Captive. The names and logos for captive are trademarks of captive-studio.
We love open source software! See our other projects or hire us to design, develop, and grow your product.
