chore(deps): update dependency husky to v9 #2107

- #!/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

`v9.1.1`

Compare Source

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 😉

`v9.1.0`

Compare Source

`v9.0.11`

Compare Source

chore: update package-lock.json by @btea in https://github.com/typicode/husky/pull/1383
fix: export HUSKY=0 in init (fixes #1393) by @typicode in https://github.com/typicode/husky/pull/1395

`v9.0.10`

Compare Source

fix: rename index.d.ts to index.d.mts by @mrkjdy in https://github.com/typicode/husky/pull/1379

`v9.0.9`

Compare Source

refactor: rename files by @typicode in https://github.com/typicode/husky/pull/1378

`v9.0.8`

Compare Source

docs: update index.md by @khaledYS in https://github.com/typicode/husky/pull/1369
Fix tab detection on install command by @glensc in https://github.com/typicode/husky/pull/1376
refactor: reduce file size by @typicode in https://github.com/typicode/husky/pull/1377

`v9.0.7`

Compare Source

fix: typo and source ~/.huskyrc correctly (compatibility with v8)
docs: fix example by @typicode in https://github.com/typicode/husky/pull/1363

`v9.0.6`

Compare Source

docs: add favicon by @rakleed in https://github.com/typicode/husky/pull/1354
chore: apply editorconfig to code only by @typicode in https://github.com/typicode/husky/pull/1355
docs: update install script to mjs and fix CI checks by @starnayuta in https://github.com/typicode/husky/pull/1357
Fix unbound variable by @typicode in https://github.com/typicode/husky/pull/1359

`v9.0.5`

Compare Source

docs: update path to startup files by @ManuelRauber in https://github.com/typicode/husky/pull/1350
fix: init error by @typicode in https://github.com/typicode/husky/pull/1353

`v9.0.4`

Compare Source

fix: init create dir before by @typicode in https://github.com/typicode/husky/pull/1348
refactor: simplify by @typicode in https://github.com/typicode/husky/pull/1349
fix: init not working on pnpm #1334 by @rozbo in https://github.com/typicode/husky/pull/1347

`v9.0.3`

Compare Source

docs: fix link by @typicode in https://github.com/typicode/husky/pull/1340
chore: fix links in issue template by @julien-f in https://github.com/typicode/husky/pull/1341
fix: add scripts field if not present by @chalkygames123 in https://github.com/typicode/husky/pull/1338
docs: changelog link by @typicode in https://github.com/typicode/husky/pull/1343
fix: insert final newline by @chalkygames123 in https://github.com/typicode/husky/pull/1339
fix: fix git hooks path on windows by @rozbo in https://github.com/typicode/husky/pull/1346

`v9.0.2`

Compare Source

fix: exit code by @gergelypap in https://github.com/typicode/husky/pull/1336
docs: typo by @chalkygames123 in https://github.com/typicode/husky/pull/1337

`v9.0.1`

Compare Source

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 🙌

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.

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())

If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

github-actions · 2024-11-25T13:14:20Z

size-limit report 📦

Path	Size
components	93.76 KB (0%)
styles	29.35 KB (0%)

codecov · 2024-11-25T13:14:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.09%. Comparing base (84da5d7) to head (7c031be).
Report is 2 commits behind head on next.

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #2107   +/-   ##
=======================================
  Coverage   97.09%   97.09%           
=======================================
  Files         110      110           
  Lines        2788     2788           
  Branches      758      758           
=======================================
  Hits         2707     2707           
  Misses         77       77           
  Partials        4        4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

- Following guidance from https://github.com/typicode/husky/releases/tag/v9.0.1

booc0mtaco · 2024-11-25T16:01:40Z

.husky/pre-commit

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


See https://github.com/typicode/husky/releases/tag/v9.0.1

chore(deps): update dependency husky to v9

b614198

czi-developer-foundations requested a review from a team as a code owner November 25, 2024 13:12

czi-developer-foundations added the npm-dependencies label Nov 25, 2024

chore: make usage adjustments

7c031be

- Following guidance from https://github.com/typicode/husky/releases/tag/v9.0.1

booc0mtaco reviewed Nov 25, 2024

View reviewed changes

booc0mtaco approved these changes Nov 25, 2024

View reviewed changes

booc0mtaco merged commit f8ee54a into next Nov 25, 2024
12 checks passed

booc0mtaco deleted the renovate/husky-9.x branch November 25, 2024 16:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(deps): update dependency husky to v9 #2107

chore(deps): update dependency husky to v9 #2107

czi-developer-foundations commented Nov 25, 2024

github-actions bot commented Nov 25, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024 •

edited

Loading

booc0mtaco Nov 25, 2024

chore(deps): update dependency husky to v9 #2107

chore(deps): update dependency husky to v9 #2107

Conversation

czi-developer-foundations commented Nov 25, 2024

Release Notes

What's Changed

New Contributors

What's Changed

New Contributors

What's Changed

New Contributors

What's new

Fixes

Deprecations

Friendly reminder

Sponsoring

Introducing husky init

v8

v9

Adding a New Hook

v8

v9

Further Size Reduction

More to Come

Other Changes

How to Migrate

github-actions bot commented Nov 25, 2024 • edited Loading

size-limit report 📦

codecov bot commented Nov 25, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Introducing `husky init`

github-actions bot commented Nov 25, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024 •

edited

Loading