Releases · typicode/husky

Kicking off the year with an exciting update!

TLDR;

Improved user experience and a (even) smaller package size while packing in more features!

👋 By the Way

I'm available for remote work (Front-end/Back-end mainly JS/TS but open to other stacks Rails, Go, Elixir). You can contact me at my mail: typicode at gmail 🙂

Introducing `husky init`

Adding husky to a project is now easier than ever. Although the installation process was straightforward, it often required consulting the documentation.

v8

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

v9

npx husky init

Adding a New Hook

Adding a hook is now as simple as creating a file. This can be accomplished using your favorite editor, a script or a basic echo command.

v8

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

v9

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 🙌

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.
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.

package.json

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

.husky/pre-commit

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

What's Changed

Feats

feat: add husky - prefix to logged global error messages by @joshbalfour in #1092
feat: show PATH when command not found to improve debuggability
feat: drop Node 12 support
feat: skip install if $HUSKY=0

Fixes

fix: hook script use /usr/bin/env sh instead of direct path of sh by @skhaz in #1051
fix: actually set 'husky_skip_init' as readonly in ./husky.sh by @hyperupcall in #1104
fix: force basename/dirname to treat $0 as an argument by @mataha in #1132
fix: remove git.io links by @renbaoshuo in #1136

Docs

docs: fix uninstall via npm by @pddpd in #1033
docs: add dog emoji as favicon by @jamiehaywood in #1095
docs: replace deprecated npx --no-install option with npx --no by @sibiraj-s in #1070
docs: add pnpm installation by @MohamadKh75 in #1139