README.md in pre-commit-0.8.0 vs README.md in pre-commit-0.8.1
- old
+ new
@@ -34,10 +34,11 @@
* ruby_symbol_hashrockets (1.9 syntax. BAD :foo => "bar". GOOD foo: "bar")
* local (executes `config/pre-commit.rb` with list of changed files)
* merge_conflict (Will check if you are about to check in a merge conflict)
* migrations (Will make sure you check in the proper files after creating a Rails migration)
* ci (Will run the `pre_commit:ci` rake task and pass or fail accordingly)
+* rubocop\_new and rubocop\_all (Check ruby code style using the rubocop gem. Rubocop must be installed)
To configure which checks you would like to run, simply set the `pre-commit.checks` git configuration setting.
To enable `white_space` and `tab` checks:
@@ -50,8 +51,13 @@
$ git config "pre-commit.checks" "white_space, console_log, debugger"
Note: If no checks are configured, a default set of checks is run:
white_space, console_log, debugger, pry, tabs, jshint, migrations, merge_conflict, local
+
+For the rubocop check, you can tell it what config file to use by setting a path relative to the repo:
+
+ # From your git repo
+ $ git config "pre-commit.rubocop.config" "config/rubocop.yml"
[1]: https://rubygems.org/gems/pre-commit
[2]: https://travis-ci.org/jish/pre-commit