Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...)
npm install @zkochan/husky> Git hooks made easy
Husky can prevent bad commit, push and more :dog: _woof!_
``sh`
npm install husky --save-dev
`sh`
yarn add husky --dev
`javascript`
// Edit package.json
{
"scripts": {
"precommit": "npm test",
"prepush": "npm test",
"...": "..."
}
}
`bash`
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._
* jQuery
* Next.js
* Hyper
* Paper.js
* Kibana
* JSON Server
* Hotel
* ... and over 8000+ other awesome projects.
`sh`
npm uninstall husky
`sh`
yarn remove husky
If you need to debug hooks, simply use npm run . For example:
`bash`
npm run precommit
If you've installed Node using the standard installer, nvm or homebrew, Git hooks will be executed in GUI applications.
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
Git params can be found in GIT_PARAMS environment variable.
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:
`json`
"precommit": "npm run some-script -q"
_-q/--quiet is equivalent to --loglevel warn which is npm default log level._
Yes
Yes
Please use yarn v0.24+`
* pkg-ok - Prevents publishing modules with bad paths
* please-upgrade-node - Show a message to upgrade Node instead of a stacktrace in your CLIs
* react-fake-props - Fake props for your React tests
MIT - Typicode :cactus: - Patreon