Skip to content
runs rubocop for changed files, can be used as pre-commit hook
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
.gitignore
.rubocop.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
LICENSE
README.md
Rakefile
rubocop_runner.gemspec

README.md

RubocopRunner

Gem Version

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.

Installation

Add these lines to your application's Gemfile:

gem 'rubocop_runner', '~> 2.1', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubocop_runner

Usage

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 Rakefile:

require 'rubocop_runner/rake_task'
RubocopRunner::RakeTask.new

Afterwards, just run the rake rubocop:install task to install the pre-commit hook.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run 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.

Contributing

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.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.