This gem provides you with a rake task to install rubocop as a git pre-commit hook. If rubocop finds any issues it will abort the commit. It will try to auto-correct all issues in the files that are being commited, but will abort the commit even if all issues can be auto-corrected so that you can verify the changes before actually commiting them.
Although this gem has no tests it's battle tested and is in use at runtastic since years.
Add these lines to your application's Gemfile:
gem 'rubocop_runner', '~> 2.1', require: false
And then execute:
Or install it yourself as:
$ gem install rubocop_runner
To create a rubocop runner pre-commit hook once just run
ruby -rrubocop_runner -e "RubocopRunner.install"
To make it easy for every developer on the project you can also add this to your
require 'rubocop_runner/rake_task' RubocopRunner::RakeTask.new
Afterwards, just run the
rake rubocop:install task to install the pre-commit
After checking out the repo, run
bin/setup to install dependencies. You can
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To
release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push
git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at http://www.oddjack.com/?certs=runtastic/rubocop_runner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.