Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency husky to v9 #1074

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

balena-renovate[bot]
Copy link
Contributor

@balena-renovate balena-renovate bot commented Jun 19, 2024

This PR contains the following updates:

Package Type Update Change
husky devDependencies major ^8.0.3 -> ^9.0.0

Release Notes

typicode/husky (husky)

v9.1.7

Compare Source

What's Changed

New Contributors

Full Changelog: typicode/husky@v9.1.6...v9.1.7

v9.1.6

Compare Source

What's Changed

New Contributors

Full Changelog: typicode/husky@v9.1.5...v9.1.6

v9.1.5

Compare Source

What's Changed

New Contributors

Full Changelog: typicode/husky@v9.1.4...v9.1.5

v9.1.4

Compare Source

  • Improve deprecation notice

v9.1.3

Compare Source

  • fix: better handle space in PATH

v9.1.2

Compare Source

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

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

v9.0.10

Compare Source

v9.0.9

Compare Source

v9.0.8

Compare Source

v9.0.7

Compare Source

v9.0.6

Compare Source

v9.0.5

Compare Source

v9.0.4

Compare Source

v9.0.3

Compare Source

v9.0.2

Compare Source

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

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


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

This PR has been generated by Renovate Bot.

Copy link
Contributor Author

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package.json
Post-upgrade command 'node -e "eval(Buffer.from('Y29uc3QgZnMgPSByZXF1aXJlKCJmcyIpOwoKLy8gRGVmaW5lIGEgcmVnZXggdG8gbWF0Y2ggdGhlIG9sZCBwcmVwYXJlIHNjcmlwdCBhbmQgYW55IHRyYWlsaW5nIHRleHQKY29uc3Qgb2xkUHJlcGFyZVJlZ2V4ID0gL15ub2RlIC1lICJ0cnkgeyByZXF1aXJlXCgnaHVza3knXClcLmluc3RhbGxcKFwpIH0gY2F0Y2ggXChlXCkge2lmIFwoZVwuY29kZSAhPT0gJ01PRFVMRV9OT1RfRk9VTkQnXCkgdGhyb3cgZX0iKC4qKSQvOwoKLy8gVXBkYXRlIHBhY2thZ2UuanNvbgpjb25zdCBwYWNrYWdlSnNvblBhdGggPSAicGFja2FnZS5qc29uIjsKY29uc3QgZGF0YSA9IEpTT04ucGFyc2UoZnMucmVhZEZpbGVTeW5jKHBhY2thZ2VKc29uUGF0aCwgInV0ZjgiKSk7CmNvbnN0IG1hdGNoID0gZGF0YS5zY3JpcHRzLnByZXBhcmUubWF0Y2gob2xkUHJlcGFyZVJlZ2V4KTsKaWYgKG1hdGNoKSB7CiAgY29uc3QgdHJhaWxpbmdUZXh0ID0gbWF0Y2hbMV07CiAgZGF0YS5zY3JpcHRzLnByZXBhcmUgPSBgbm9kZSAtZSAidHJ5IHsgKGF3YWl0IGltcG9ydCgnaHVza3knKSkuZGVmYXVsdCgpIH0gY2F0Y2ggKGUpIHsgaWYgKGUuY29kZSAhPT0gJ0VSUl9NT0RVTEVfTk9UX0ZPVU5EJykgdGhyb3cgZSB9IiAtLWlucHV0LXR5cGUgbW9kdWxlJHt0cmFpbGluZ1RleHR9YDsKfQovLyBFbnN1cmluZyB0aGVyZSBpcyBhIG5ld2xpbmUgYXQgdGhlIGVuZCB3aGVuIHdyaXRpbmcgdG8gJ3BhY2thZ2UuanNvbicKZnMud3JpdGVGaWxlU3luYyhwYWNrYWdlSnNvblBhdGgsIEpTT04uc3RyaW5naWZ5KGRhdGEsIG51bGwsIDIpICsgIlxuIik7CgovLyBVcGRhdGUgLmh1c2t5L3ByZS1jb21taXQKY29uc3QgcHJlQ29tbWl0UGF0aCA9ICIuaHVza3kvcHJlLWNvbW1pdCI7CmlmIChmcy5leGlzdHNTeW5jKHByZUNvbW1pdFBhdGgpKSB7CiAgbGV0IGNvbnRlbnQgPSBmcy5yZWFkRmlsZVN5bmMocHJlQ29tbWl0UGF0aCwgInV0ZjgiKTsKICBjb25zdCBsaW5lc1RvUmVtb3ZlID0gWwogICAgIiMhL3Vzci9iaW4vZW52IHNoIiwKICAgICcuICIkKGRpcm5hbWUgLS0gIiQwIikvXy9odXNreS5zaCInLAogIF07CiAgY29udGVudCA9IGNvbnRlbnQKICAgIC5zcGxpdCgiXG4iKQogICAgLmZpbHRlcigobGluZSkgPT4gIWxpbmVzVG9SZW1vdmUuaW5jbHVkZXMobGluZSkpCiAgICAuam9pbigiXG4iKTsKICBmcy53cml0ZUZpbGVTeW5jKHByZUNvbW1pdFBhdGgsIGNvbnRlbnQpOwp9Cg==', 'base64').toString('utf-8'))"' has not been added to the allowed list in allowedPostUpgradeCommands

@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 3 times, most recently from 628cee0 to a835ea7 Compare July 8, 2024 01:54
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 4 times, most recently from 97921c0 to d0cee68 Compare July 15, 2024 12:44
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 2 times, most recently from 7208d84 to 41173d4 Compare July 22, 2024 01:56
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 2 times, most recently from 25deddf to f8c703e Compare July 29, 2024 01:56
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 6 times, most recently from 9ec0472 to 5bfdae5 Compare August 8, 2024 16:38
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 3 times, most recently from c8187fd to ea1ff32 Compare August 19, 2024 01:56
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 5 times, most recently from 98a2ba3 to 945b62a Compare August 26, 2024 01:56
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 2 times, most recently from ed54c22 to 01c3d07 Compare August 30, 2024 19:35
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 3 times, most recently from 8950a19 to f47675a Compare September 23, 2024 02:03
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 5 times, most recently from 196ebdd to f72a284 Compare October 7, 2024 19:36
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 4 times, most recently from 3e10c7c to 7a05c68 Compare October 14, 2024 02:05
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 5 times, most recently from 92c4ca5 to d4cb1ea Compare October 24, 2024 15:38
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 2 times, most recently from d5472fd to f83d209 Compare October 28, 2024 02:06
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 2 times, most recently from 7d4c548 to cd5f6c9 Compare November 11, 2024 02:04
@balena-renovate balena-renovate bot force-pushed the renovate/major-9-husky branch 3 times, most recently from 33aab44 to 8cdfeec Compare November 18, 2024 02:08
Update husky from 8.0.3 to 9.1.7

Change-type: patch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants