README.md in pre-commit-0.26.0 vs README.md in pre-commit-0.27.0
- old
+ new
@@ -3,11 +3,11 @@
[](https://rubygems.org/gems/pre-commit)
[](https://codeclimate.com/github/jish/pre-commit)
[](https://coveralls.io/r/jish/pre-commit?branch=master)
[](https://travis-ci.org/jish/pre-commit)
[](https://gemnasium.com/jish/pre-commit)
-[](http://rubydoc.info/gems/pre-commit/frames)
+[](http://www.rubydoc.info/gems/pre-commit/frames)
## Installation
Install the gem
@@ -26,11 +26,12 @@
$ rvm default do gem install pre-commit
Alternatively you can configure pre-commit to use the ```current``` rvm gemset
- $ git config pre-commit.ruby "rvm `rvm current` do ruby"
+ $ git config pre-commit.ruby "rvm `rvm current` do ruby" # OR:
+ $ git config pre-commit.ruby `rvm wrapper current show ruby` # available in RVM 1.26.12
## Available checks
These are the available checks:
@@ -39,23 +40,23 @@
* debugger
* pry
* tabs
* jshint
* js_lint
-* closure\_syntax\_check
* php (Runs php -l on all staged files)
* rspec_focus (Will check if you are about to check in a :focus in a spec file)
* 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 (Check ruby code style using the rubocop gem. Rubocop must be installed)
* before_all (Check your RSpec tests for the use of `before(:all)`)
* coffeelint (Check your coffeescript files using the [coffeelint gem.](https://github.com/clutchski/coffeelint))
-* go (Runs go fmt on a go source file and fail if formatting is incorrect, then runs go build and fails if can't compile)
-* scss_lint (Check your SCSS files using the [scss-lint gem](https://github.com/causes/scss-lint))
+* gobuild (Runs go build and fails if can't compile)
+* gofmt (Runs go fmt on go source files and fail if formatting is incorrect)
+* scss_lint (Check your SCSS files using the [scss-lint gem](https://github.com/brigade/scss-lint))
* yaml (Check that your YAML is parsable)
* json (Checks if JSON is parsable)
## Default checks
@@ -63,15 +64,15 @@
## Enabling / Disabling Checks / Warnings
### Git configuration
- git config pre-commit.checks "whitespace, jshint, debugger"
+ git config pre-commit.checks "[whitespace, jshint, debugger]"
To disable, simply leave one off the list
- git config pre-commit.checks "whitespace, jshint"
+ git config pre-commit.checks "[whitespace, jshint]"
### CLI configuration
```ssh
pre-commit <enable|disable> <git|yaml> <checks|warnings> check1 [check2...]
@@ -123,8 +124,8 @@
the list of git files to check with:
1. `.gitignore` - git supported file shared beteen all checkouts
2. `.git/info/exclude` - git supported file only for this checkout
3. `.pre_commit.ignore` - `pre-commit` specific list can be shared,
- [Allowed filters](http://www.ruby-doc.org/core-2.1.3/File.html#method-c-fnmatch)
+ [Allowed filters](http://ruby-doc.org/core-2.1.3/File.html#method-c-fnmatch)
## [Contributing](CONTRIBUTING.md)