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

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

Merged
merged 3 commits into from
Nov 12, 2024
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 28, 2024

This PR contains the following updates:

Package Type Update Change OpenSSF
husky devDependencies major 8.0.3 -> 9.1.6 OpenSSF Scorecard

Release Notes

typicode/husky (husky)

v9.1.6

Compare Source

v9.1.5

Compare Source

v9.1.4

Compare Source

v9.1.3

Compare Source

  • fix: better handle space in PATH

v9.1.2

Compare Source

v9.1.1

Compare Source

v9.1.0

Compare Source

Super saiyan god dog! It's over 9.0.0!

There's a bug with this release which prevents the deprecation notice to appear and requires to remove #!/usr/bin/env sh and . "$(dirname -- "$0")/_/husky.sh" (which are deprecated by the way). I'll publish a new version to fix that. Sorry about any inconvenience.

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

  • Remove #!/usr/bin/env sh and . "$(dirname -- "$0")/_/husky.sh" from your hooks
  • Move your code from ~/.huskyrc to .config/husky/init.sh

Support for these will be removed in v10, notices have been added.

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

What's Changed

New Contributors

Full Changelog: typicode/husky@v9.0.1...v9.0.2

v9.0.1

Compare Source

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

Configuration

📅 Schedule: Branch creation - "before 5am every weekday,every weekend" (UTC), Automerge - At any time (no schedule defined).

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

Rebasing: Whenever PR becomes conflicted, 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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the dependencies Pull requests that update a dependency file label Jan 28, 2024
@renovate renovate bot force-pushed the renovate/husky-9.x branch 4 times, most recently from 599b7ce to 77a7240 Compare February 1, 2024 23:39
@renovate renovate bot force-pushed the renovate/husky-9.x branch 2 times, most recently from fb897f3 to 6c8ff79 Compare February 4, 2024 18:36
@renovate renovate bot force-pushed the renovate/husky-9.x branch 2 times, most recently from 9cee7f5 to 711fd86 Compare July 21, 2024 13:21
@renovate renovate bot force-pushed the renovate/husky-9.x branch 3 times, most recently from 6b27854 to a075522 Compare August 1, 2024 15:30
@renovate renovate bot force-pushed the renovate/husky-9.x branch 2 times, most recently from 7e16bf0 to 86405cc Compare November 4, 2024 05:50
Copy link
Contributor Author

renovate bot commented Nov 4, 2024

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@intcreator intcreator force-pushed the renovate/husky-9.x branch 2 times, most recently from e484311 to f136414 Compare November 7, 2024 20:11
@sheerlox sheerlox merged commit 9ea2216 into main Nov 12, 2024
18 checks passed
@sheerlox sheerlox deleted the renovate/husky-9.x branch November 12, 2024 01:08
@ncb000gt
Copy link
Member

🎉 This PR is included in version 3.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

intcreator pushed a commit that referenced this pull request Nov 12, 2024
## [3.2.0](v3.1.9...v3.2.0) (2024-11-12)

### ✨ Features

* add support for Node v22 ([#914](#914)) ([9147b20](9147b20))

### ⚙️ Continuous Integrations

* **action:** update actions/checkout action to v4.2.2 ([#880](#880)) ([293f54a](293f54a))
* **action:** update actions/checkout digest to 11bd719 ([#879](#879)) ([0287c69](0287c69))
* **action:** update actions/setup-node digest to 39370e3 ([#889](#889)) ([0f7a3aa](0f7a3aa))
* **action:** update actions/upload-artifact action to v4.4.3 ([#878](#878)) ([226ad5b](226ad5b))
* **action:** update step-security/harden-runner action to v2.10.1 ([#882](#882)) ([b09438e](b09438e))

### ♻️ Chores

* **deps:** lock file maintenance ([ad613cb](ad613cb))
* **deps:** update dependency [@fast-check](https://github.com/fast-check)/jest to v2.0.3 ([2d00739](2d00739))
* **deps:** update dependency [@semantic-release](https://github.com/semantic-release)/github to v11.0.1 ([a17bbdd](a17bbdd))
* **deps:** update dependency [@types](https://github.com/types)/node to v20.17.6 ([4509c4d](4509c4d))
* **deps:** update dependency husky to v9 ([#844](#844)) ([9ea2216](9ea2216))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants