🐶 husky

Appearance

On this page

Guide ​

Monorepo ​

It's recommended to add husky in root package.json. You can use tools like lerna and filters to only run scripts in packages that have been changed.

Custom directory ​

If you want to install husky in another directory, for example .config, you can pass it to install command. For example:

js
{
  "scripts": {
    "prepare": "husky install .config/husky"
  }
}

Another case you may be in is if your package.json file and .git directory are not at the same level. For example, project/.git and project/front/package.json.

By design, husky install must be run in the same directory as .git, but you can change directory during prepare script and pass a subdirectory:

js
{
  "scripts": {
    "prepare": "cd .. && husky install front/.husky"
  }
}

In your hooks, you'll also need to change directory:

shell
# ...
cd front
npm test

Bypass hooks ​

You can bypass pre-commit and commit-msg hooks using Git -n/--no-verify option:

shell
git commit -m "yolo!" --no-verify

For Git commands that don't have a --no-verify option, you can use HUSKY environment variable:

shell
HUSKY=0 git push # yolo!

Disable husky in CI/Docker/Prod ​

There's no right or wrong way to disable husky in CI/Docker/Prod context and is highly dependent on your use-case.

With npm ​

If you want to prevent husky from installing completely, you can specifically disable prepare script with:

shell
npm pkg delete scripts.prepare
npm ci --omit=dev

Alternatively, you can ignore scripts during installation. Be cautious, this argument ignores dependencies scripts as well.

shell
npm ci --omit=dev --ignore-scripts

When using --omit=dev, npm will set NODE_ENV to production for lifecycle scripts, so another alternative is to check it to conditionally install husky.

shell
npm pkg set scripts.prepare="node -e \"if (process.env.NODE_ENV !== 'production') { require('husky').install() }\""

With a custom script ​

You can create a custom JS script and conditionally require husky and install hooks.

json
"prepare": "node ./prepare.js"
js
const isCi = process.env.CI !== undefined
if (!isCi) {
  require('husky').install()
}

Or make prepare script fail silently if husky is not installed:

json
"prepare": "node -e \"try { require('husky').install() } catch (e) {if (e.code !== 'MODULE_NOT_FOUND') throw e}\""

With env variables ​

You can set HUSKY environment variable to 0 in your CI config file, to disable hooks installation.

Alternatively, most Continuous Integration Servers set a CI environment variable. You can use it in your hooks to detect if it's running in a CI.

shell
# ...
[ -n "$CI" ] && exit 0

With is-ci ​

You can also use is-ci in your prepare script to conditionally install husky

shell
npm install is-ci --save-dev
js
{
  "scripts": {
    "prepare": "is-ci || husky install"
  }
}

Test hooks ​

If you want to test a hook, you can add exit 1 at the end of the script to abort git command.

shell
# ...
exit 1 # Commit will be aborted

Git-flow ​

If using git-flow you need to ensure your git-flow hooks directory is set to use Husky's (.husky by default).

shell
git config gitflow.path.hooks .husky

Note:

  • If you are configuring git-flow after you have installed husky, the git-flow setup process will correctly suggest the .husky directory.
  • If you have set a custom directory for husky you need to specify that (ex. git config gitflow.path.hooks .config/husky)

To revert the git-flow hooks directory back to its default you need to reset the config to point to the default Git hooks directory.

shell
git config gitflow.path.hooks .git/hooks