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

Merged
Kichiyaki merged 1 commits from renovate/husky-9.x into master 2024-04-04 03:50:40 +00:00
Collaborator

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 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 has been generated by Renovate Bot.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [husky](https://github.com/typicode/husky) | devDependencies | major | [`^8.0.3` -> `^9.0.0`](https://renovatebot.com/diffs/npm/husky/8.0.3/9.0.11) | --- ### Release Notes <details> <summary>typicode/husky (husky)</summary> ### [`v9.0.11`](https://github.com/typicode/husky/releases/tag/v9.0.11) [Compare Source](https://github.com/typicode/husky/compare/v9.0.10...v9.0.11) - chore: update `package-lock.json` by [@&#8203;btea](https://github.com/btea) in https://github.com/typicode/husky/pull/1383 - fix: `export HUSKY=0` in init (fixes [#&#8203;1393](https://github.com/typicode/husky/issues/1393)) by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1395 ### [`v9.0.10`](https://github.com/typicode/husky/releases/tag/v9.0.10) [Compare Source](https://github.com/typicode/husky/compare/v9.0.9...v9.0.10) - fix: rename index.d.ts to index.d.mts by [@&#8203;mrkjdy](https://github.com/mrkjdy) in https://github.com/typicode/husky/pull/1379 ### [`v9.0.9`](https://github.com/typicode/husky/releases/tag/v9.0.9) [Compare Source](https://github.com/typicode/husky/compare/v9.0.8...v9.0.9) - refactor: rename files by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1378 ### [`v9.0.8`](https://github.com/typicode/husky/releases/tag/v9.0.8) [Compare Source](https://github.com/typicode/husky/compare/v9.0.7...v9.0.8) - docs: update index.md by [@&#8203;khaledYS](https://github.com/khaledYS) in https://github.com/typicode/husky/pull/1369 - Fix tab detection on install command by [@&#8203;glensc](https://github.com/glensc) in https://github.com/typicode/husky/pull/1376 - refactor: reduce file size by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1377 ### [`v9.0.7`](https://github.com/typicode/husky/releases/tag/v9.0.7) [Compare Source](https://github.com/typicode/husky/compare/v9.0.6...v9.0.7) - fix: typo and source `~/.huskyrc` correctly (compatibility with v8) - docs: fix example by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1363 ### [`v9.0.6`](https://github.com/typicode/husky/releases/tag/v9.0.6) [Compare Source](https://github.com/typicode/husky/compare/v9.0.5...v9.0.6) - docs: add favicon by [@&#8203;rakleed](https://github.com/rakleed) in https://github.com/typicode/husky/pull/1354 - chore: apply editorconfig to code only by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1355 - docs: update install script to mjs and fix CI checks by [@&#8203;starnayuta](https://github.com/starnayuta) in https://github.com/typicode/husky/pull/1357 - Fix unbound variable by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1359 ### [`v9.0.5`](https://github.com/typicode/husky/releases/tag/v9.0.5) [Compare Source](https://github.com/typicode/husky/compare/v9.0.4...v9.0.5) - docs: update path to startup files by [@&#8203;ManuelRauber](https://github.com/ManuelRauber) in https://github.com/typicode/husky/pull/1350 - fix: init error by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1353 ### [`v9.0.4`](https://github.com/typicode/husky/releases/tag/v9.0.4) [Compare Source](https://github.com/typicode/husky/compare/v9.0.3...v9.0.4) - fix: init create dir before by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1348 - refactor: simplify by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1349 - fix: init not working on pnpm [#&#8203;1334](https://github.com/typicode/husky/issues/1334) by [@&#8203;rozbo](https://github.com/rozbo) in https://github.com/typicode/husky/pull/1347 ### [`v9.0.3`](https://github.com/typicode/husky/releases/tag/v9.0.3) [Compare Source](https://github.com/typicode/husky/compare/v9.0.2...v9.0.3) - docs: fix link by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1340 - chore: fix links in issue template by [@&#8203;julien-f](https://github.com/julien-f) in https://github.com/typicode/husky/pull/1341 - fix: add scripts field if not present by [@&#8203;chalkygames123](https://github.com/chalkygames123) in https://github.com/typicode/husky/pull/1338 - docs: changelog link by [@&#8203;typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1343 - fix: insert final newline by [@&#8203;chalkygames123](https://github.com/chalkygames123) in https://github.com/typicode/husky/pull/1339 - fix: fix git hooks path on windows by [@&#8203;rozbo](https://github.com/rozbo) in https://github.com/typicode/husky/pull/1346 ### [`v9.0.2`](https://github.com/typicode/husky/releases/tag/v9.0.2) [Compare Source](https://github.com/typicode/husky/compare/v9.0.1...v9.0.2) - fix: exit code by [@&#8203;gergelypap](https://github.com/gergelypap) in https://github.com/typicode/husky/pull/1336 - docs: typo by [@&#8203;chalkygames123](https://github.com/chalkygames123) in https://github.com/typicode/husky/pull/1337 ### [`v9.0.1`](https://github.com/typicode/husky/releases/tag/v9.0.1) [Compare Source](https://github.com/typicode/husky/compare/v8.0.3...v9.0.1) <p align="center"> Kicking off the year with an exciting update! </p> <p align="center"> <img src="https://github.com/typicode/husky/assets/5502029/457ab087-e935-4196-b99f-601ecf37f263" height="400px" alt="" /> </p> *Note: install using `husky@latest` to get the bug fixes that were released after.* #### Introducing `husky init` ##### v8 ```shell 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. ```shell npx husky init ``` #### Adding a New Hook ##### v8 ```shell 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: ```shell 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 :raised_hands: #### 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` ```diff { "scripts": { - "prepare": "husky install" + "prepare": "husky" } } ``` `.husky/pre-commit` ```diff - #!/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: ```diff - const husky = require('husky') - // ... + import husky from 'husky' + console.log(husky()) ``` </details> --- ### 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 becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjIuMSIsInVwZGF0ZWRJblZlciI6IjM3LjI2Mi4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIn0=-->
renovate added the
dependencies
label 2024-04-03 19:32:24 +00:00
renovate added 1 commit 2024-04-03 19:32:24 +00:00
ci/woodpecker/pr/test Pipeline was successful Details
28fac03742
chore(deps): update dependency husky to v9
Kichiyaki merged commit 82b864946b into master 2024-04-04 03:50:40 +00:00
Kichiyaki deleted branch renovate/husky-9.x 2024-04-04 03:50:41 +00:00
Sign in to join this conversation.
No reviewers
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: twhelp/scripts#98
No description provided.