husky

Git hooks made easy

beta branch, see master for stable release documentation

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

Install

npm install husky@beta --save-dev

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

git commit -m 'Keep calm and commit'

Uninstall

npm uninstall husky

Upgrade

If you're upgrading from 0.14 simply move your hooks to "husky" field.

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

Alternatively, you may 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.

Configure

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.

Features

• Fast, minimalist and simple
• Keeps existing user hooks
• Supports GUI Git clients
• Supports all Git hooks (pre-commit, pre-push, ...)
• Supports monorepo/sub-directories layouts
• If you were using ghooks, it will migrate your Git hooks

Used by

• jQuery
• babel
• create-react-app
• Next.js
• Hyper
• Kibana
• JSON Server
• Hotel
• ... and over 10k+ other awesome repos.

See also

• 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

License

MIT - Typicode 🌵 - Patreon