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 #157

Merged
merged 1 commit into from
Apr 12, 2024
Merged

Update dependency husky to v9 #157

merged 1 commit into from
Apr 12, 2024

Conversation

balena-renovate[bot]
Copy link
Contributor

@balena-renovate balena-renovate bot commented Feb 5, 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.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.

@balena-renovate balena-renovate bot force-pushed the renovate/major-husky branch from 6d6f8fc to 4a20229 Compare February 9, 2024 16:58
@balena-renovate balena-renovate bot force-pushed the renovate/major-husky branch 4 times, most recently from d7dc1f1 to 2ae1440 Compare February 27, 2024 21:53
@balena-renovate balena-renovate bot force-pushed the renovate/major-husky branch from 2ae1440 to 5c05997 Compare March 21, 2024 03:51
@balena-renovate balena-renovate bot force-pushed the renovate/major-husky branch from 5c05997 to 2a3554e Compare March 28, 2024 23:55
@balena-renovate balena-renovate bot force-pushed the renovate/major-husky branch 3 times, most recently from fb774ee to 40ea2da Compare April 12, 2024 11:57
@Page- Page- enabled auto-merge April 12, 2024 16:19
Update husky from 8.0.3 to 9.0.11

Change-type: patch
@balena-renovate balena-renovate bot force-pushed the renovate/major-husky branch from 40ea2da to be5c8a1 Compare April 12, 2024 16:29
@Page- Page- merged commit 535afbf into master Apr 12, 2024
46 checks passed
@Page- Page- deleted the renovate/major-husky branch April 12, 2024 16:35
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.

1 participant