docs.md

Documentation

Supported hooks

husky supports all Git hooks defined here.

Access Git params

You can access them using GIT_PARAMS environment variable.

Disable auto-install

If you don't want husky to automatically install Git hooks, simply set HUSKY_SKIP_INSTALL environment variable to true.

HUSKY_SKIP_INSTALL=true npm install

Multi-package repository (monorepo)

If you have a multi-package repository:

.
└── root
    ├── .git
    ├── package.json 🐶 # add husky here
    └── packages
        ├── A
        │   └── package.json
        ├── B
        │   └── package.json
        └── C
            └── package.json

It's recommended to use tools like lerna and have husky installed in the root package.json:

{
  "private": true,
  "devDependencies": {
    "husky": "..."
  },
  "husky": {
    "hooks": {
      "pre-commit": "lerna run test"
    }
  }
}

Sub-directory package

If your project is in a sub-directory, create a root package.json, run npm install husky --save-dev and edit package.json to configure husky:

.
└── root
    ├── .git
    ├── package.json 🐶 # add husky here
    └── subdirectory
        └── package.json

// Create root/package.json
{
  "private": true,
  "devDependencies": {
    "husky": "..."
  },
  "husky": {
    "hooks": {
      "pre-commit": "cd subproject && npm test"
    }
  }
}

One of the downside of this approach is that you'll have to run npm install in project and subproject. If you only have one package and you're not publishing it, you can do the following to ensure that husky is also installed when you run npm install in your subdirectory:

// root/subdirectory/package.json
{
  "private": true,
  "scripts": {
    "postinstall": "cd .. && npm install"
  }
}