husky

Git hooks made easy

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

Used by:

• jQuery
• Kibana
• JSON Server
• Hotel
• and many other awesome projects!

Usage

npm install husky --save-dev

// package.json
{
  "scripts": {
    "precommit": "npm test",
    "prepush": "npm test",
    "...": "..."
  }
}

git commit -m "Keep calm and commit"

Existing hooks aren't replaced and adding --no-verify to your git commands lets you bypass hooks. You can also use any Git hook.

Extras

Debug

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

npm run precommit

GUI applications

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

NVM support

On OS X and Linux, husky will try to use the default installed version or read project's .nvmrc.

Uninstall

To uninstall husky and Git hooks, simply run:

npm uninstall husky --save-dev

License

MIT - typicode