husky
Git hooks made easy
Husky can prevent bad commit, push and more :dog: woof!
Install
npm install husky --save-dev
{
"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.
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 even in GUI applications.
In the case of nvm
, husky will try to use the default
installed version or use the project .nvmrc
.
Accessing Git params
Git params can be found in GIT_PARAMS
environment variable.
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
.
License
MIT - Typicode :cactus: