husky

Show a message instead of automatically removing deprecated code.

This only concerns projects that still have the following code in their hooks:

- #!/usr/bin/env sh # <- This is deprecated, remove it
- . "$(dirname -- "$0")/_/husky.sh"  # <- This is deprecated, remove it

# Rest of your hook code

Hooks with these lines will fail in v10.0.0

Super saiyan god dog! It's over 9.0.0!

What's new

You can now run package commands directly, no need for npx or equivalents.
It makes writing hooks more intuitive and is also slightly faster 🐺⚡️

# .husky/pre-commit
- npx jest
+ jest # ~0.2s faster

A new recipe has been added to the docs. Lint staged files without external dependencies (inspired by Prettier docs). Feel free to modify it.

# .husky/pre-commit
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
git update-index --again

For more advanced use cases, see lint-staged.

Fixes

• bunx husky init command

• Workaround for some hooks implementation on Windows

Deprecations

• deprecated

  #!/usr/bin/env sh and . "$(dirname -- "$0")/_/husky.sh" are deprecated. husky command will automatically remove them, no action required.

• deprecated

  If you're having code in ~/.huskyrc please move it to .config/husky/init.sh

Support for these will be removed in v10.

Friendly reminder

If Git hooks don't fit your workflow, you can disable Husky globally. Just add export HUSKY=0 to .config/husky/init.sh.

I've seen some confusion about this on X, so just a heads-up!

Sponsoring

Husky is downloaded over 45M times per month and used by ~1.5M projects. If your company wants to sponsor, you can do so here: GitHub Sponsors.

Have a nice summer ☀️ I'm open to new opportunities/consulting so feel free to drop me a message 😉

• export HUSKY=0 in init (fixes #1393)

• Fix tab detection on install command

• Fix unbound variable

• Init error

• Init create dir before

• Init not working on pnpm #1334

• Add scripts field if not present

• Insert final newline

• Fix git hooks path on windows

• Exit code

Kicking off the year with an exciting update!

Note: install using husky@latest to get the bug fixes that were released after.

Introducing husky init

v8

npm pkg set scripts.prepare="husky install"
npm run prepare
npx husky add .husky/pre-commit "npm test"

v9

Adding husky to a project is now easier than ever. It's just a single line that does the same as above. No need to read the docs to get started anymore.

npx husky init

Adding a New Hook

v8

npx husky add  .husky/pre-commit "npm test"
git add --chmod=+x .husky/pre-commit # On Windows

v9

Adding a hook is as simple as creating a file. This can be accomplished using your favorite editor, a script or a basic echo command. For example, on Linux/macOS:

echo "npm test" > .husky/pre-commit

Further Size Reduction

v8 was already the most compact Git hooks manager at approximately 6kB.

v9 takes this a step further, reducing the size to just 3kB, likely making it the smallest devDependency in your toolkit.

To give you an idea of how small it is, the biggest file in the project is the MIT license 😄

More to Come

Additional features are in the pipeline for v9. Stay tuned :raised_hands:

Other Changes

• Enhanced security with CI and npm --provenance for safer publishing.

• Added $XDG_CONFIG_HOME support. Move ~/.huskyrc to ~/.config/husky/init.sh for centralized configuration.

• Fixed permission issue for Windows-created hooks; they no longer need to be executable.

• Removed husky install. Use husky or husky some/dir for the same functionality (deprecation notice to be added).

• Modified behavior when .git is missing; it now triggers a warning instead of failure.

• Replaced HUSKY_DEBUG=1 with HUSKY=2 for debugging.

• Updated the Husky API for module usage.

• Transitioned to ESM for module usage.

• removed

  Dropped support for Node 14 and 16.

• Revamped docs.

How to Migrate

v9 is backward compatible with v8, allowing you to freely upgrade and migrate your hooks later.

Here are the steps to migrate:

package.json

{
  "scripts": {
-   "prepare": "husky install"
+   "prepare": "husky"
  }
}

.husky/pre-commit

- #!/usr/bin/env sh
- . "$(dirname -- "$0")/_/husky.sh"
npm test 

Note: sh will be used to run hooks, even if a shebang is set.

If you were using husky as a module:

- const husky = require('husky')
- // ...
+ import husky from 'husky'
+ console.log(husky())

What's Changed

Feats

• Add husky - prefix to logged global error messages

• Show PATH when command not found to improve debuggability

• removed

  Drop Node 12 support

• Skip install if $HUSKY=0

Fixes

• Hook script use /usr/bin/env sh instead of direct path of sh

• Actually set 'husky_skip_init' as readonly in ./husky.sh

• Force basename/dirname to treat $0 as an argument

• Remove git.io links

• Improve .husky/ directory structure. .husky/.gitignore is now unnecessary and can be removed.

• Improve error output (shorter)

• Update husky-init CLI

• Update husky-4-to-7 CLI

• removed

  Drop Node 10 support

Please help me develop and release OSS projects :heart: on GitHub Sponsors or Open Collective. Thank you for your support!

After being in early access for Open Source projects and Sponsors for a limited time, I'm happy to announce that husky 6 is MIT again and can be freely used in commercial projects! 🎉

Many thanks to the Open Source projects and Companies which have switched to/sponsored the new husky during this period!

OSS is my full-time job, please consider sponsoring the development of husky on GitHub sponsors or Open Collective. Thank you!

Breaking change

• breaking

  husky init has been moved to its own package (npx husky-init)

Added

• Programmatically use husky: require('husky')

• TypeScript definitions

Migrating from husky 4

Husky 6 contains breaking changes. If you're coming from v4, npm install husky@6 won't be enough.

Recommended: see husky-4-to-6 CLI to automatically migrate your config. There's also a dedicated section in the docs.

If you're curious why config has changed, you may be interested in reading:
blog.typicode.com/husky-git-hooks-javascript-co…

Also Husky 6 follows official npm and Yarn best practices regarding autoinstall. It's recommended to use prepare script instead (see usage in docs).

• cli: husky init will detect Yarn v2 and initialize accordingly

• cli: husky init use prepare script

• init: Update package.json postinstall

• install: Do not fail if not inside a Git directory (closes #851)

See github.com/typicode/husky/releases/tag/v5.0.0 for v5 release notes

👉 See typicode.github.io/husky for breaking changes and new installation instructions.

Note about the license

Husky 5 is released under The Parity Public License.

It doesn't affect you if you're using husky in an Open Source project or if you're a sponsor. You're free to use it as usual and I hope you'll enjoy this new release ❤️

If you're using husky in a commercial project, you may want to consider becoming a sponsor to support the project. You can also try it for 30 days.

This is only for a limited time, husky will be MIT again later.

Migrating

Important Husky v5 brings a lot of improvements but is also very different from v4. Git hooks won't work if you only upgrade husky dependency, existing config needs to be migrated too.

The best way to switch to v5 is to follow the new installation instructions and migrate existing hooks command using husky add.