🐶 Git hooks made easy
JavaScript
Latest commit df86893 Mar 24, 2017 @typicode committed on GitHub Update CHANGELOG.md
Permalink
Failed to load latest commit information.
bin Update Jan 16, 2017
src Comments Mar 22, 2017
test Make it easier to migrate from ghooks Jan 22, 2017
.gitignore First commit Jun 23, 2014
.travis.yml Update .travis.yml Mar 2, 2017
CHANGELOG.md Update CHANGELOG.md Mar 24, 2017
HOOKS.md Add missing hooks (Fix issue #52) (#62) Sep 2, 2016
LICENSE First commit Jun 23, 2014
README.md Update README.md Mar 24, 2017
package.json 0.13.3 Mar 24, 2017

README.md

husky npm version Build Status

Git hooks made easy

Husky can prevent bad commit, push and more 🐶 woof!

Install

npm install husky --save-dev
// Edit package.json
{
  "scripts": {
    "precommit": "npm test",
    "prepush": "npm test",
    "...": "..."
  }
}
git commit -m "Keep calm and commit"

Existing hooks aren't replaced and you can use any Git hook.

If you're migrating from ghooks, simply run npm uninstall ghooks --save-dev && npm install husky --save-dev and edit package.json. Husky will automatically migrate ghooks hooks.

Used by

Uninstall

npm uninstall husky --save-dev

Tricks

Debug hooks easily

If you need to debug hooks, simply use npm run <script-name>. For example:

npm run precommit

Git GUI clients support

If you've installed Node using the standard installer, nvm or homebrew, Git hooks will be executed in GUI applications.

Working with multiple version of Node

If nvm is installed, husky will try to use the default/current installed Node version or use the project .nvmrc.

Tip to use the system-installed version of node, nvm provides a system alias

Accessing Git params

Git params can be found in GIT_PARAMS environment variable.

Setting a different log level

By default, husky will run scripts using --silent to make the output more readable. If you want to override this, simply pass a different log level to your scripts:

"precommit": "npm run some-script -q"

-q/--quiet is equivalent to --loglevel warn which is npm default log level.

Git submodule support

Yes

Cygwin support

Yes

Yarn

For Yarn, you currently need to pass --force to be sure that hooks are going to be installed (yarn add husky --dev --force). You can also manually install hooks using node node_modules/husky/bin/install.

See also

  • pkg-ok - prevents publishing modules with bad paths

License

MIT - Typicode 🌵