Update husky 8.0.3 → 9.1.5 (major)

[depfu]

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ husky (8.0.3 → 9.1.5) · Repo · Changelog

Release Notes

9.1.5

What's Changed

• fixes #1494, support pre-merge-commit hook by @RainMeoCat in #1497

New Contributors

• @RainMeoCat made their first contribution in #1497

Full Changelog: v9.1.4...v9.1.5

9.1.4

• Improve deprecation notice

9.1.3

• fix: better handle space in PATH

9.1.2

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

9.1.1

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

• #!/usr/bin/env sh and . "$(dirname -- "$0")/_/husky.sh" are deprecated. husky command will automatically remove them, no action required.
• 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 😉

9.0.11

• chore: update package-lock.json by @btea in #1383
• fix: export HUSKY=0 in init (fixes #1393) by @typicode in #1395

9.0.10

• fix: rename index.d.ts to index.d.mts by @mrkjdy in #1379

9.0.7

• fix: typo and source ~/.huskyrc correctly (compatibility with v8)
• docs: fix example by @typicode in #1363

9.0.6

• docs: add favicon by @rakleed in #1354
• chore: apply editorconfig to code only by @typicode in #1355
• docs: update install script to mjs and fix CI checks by @starnayuta in #1357
• Fix unbound variable by @typicode in #1359

9.0.5

• docs: update path to startup files by @ManuelRauber in #1350
• fix: init error by @typicode in #1353

9.0.1

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

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by more commits than we can show here.

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu cancel merge

Cancels automatic merging of this PR

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)

[coveralls]

Pull Request Test Coverage Report for Build 10584158446

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 85.531%

---

Totals
Change from base Build 9455325337:	0.0%
Covered Lines:	569
Relevant Lines:	649

---

💛 - Coveralls

[depfu]

Closed in favor of #348.

[depfu]

Closed in favor of #348.