husky

Git hooks made easy

Husky can prevent bad git commit, git push and more :dog: woof!

You're viewing the documentation for the next version of husky, click here if you prefer to use the stable release

Install

npm install husky@next --save-dev

// package.json
{
  "husky": {
    "hooks": {
      "pre-commit": "npm test",
      "pre-push": "npm test",
      "...": "..."
    }
  }
}

git commit -m 'Keep calm and commit'

By default, husky expects your project's package.json and your .git directory to be at the same level. It can be configured to support monorepos or sub-directories.

Check documentation for more.

Uninstall

npm uninstall husky

Upgrading from 0.14

If you're upgrading from 0.14, simply move your hooks to husky.hooks:

{
  "scripts": {
-   "precommit": "npm test"
  },
+ "husky": {
+   "hooks": {
+     "pre-commit": "npm test"
+   }
+ }
}

Or run the following command which will do the same automatically for you ;)

./node_modules/.bin/husky-upgrade

Alternatively, you can also use any of the files/formats that are supported by cosmiconfig. This means that you can place your husky hooks config in a .huskyrc file or export them from a husky.config.js file as well. Cosmiconfig supports js, json, and yaml file formats.

Features

Keeps existing user hooks
Supports GUI Git clients
Supports all Git hooks (pre-commit, pre-push, ...)
Auto-migrates Git hooks installed by ghooks

Used by

License

MIT - Typicode :cactus: - Patreon

Current Tags

9.1.6 ... latest (2 months ago)