Improved user experience and a (even) smaller package size while packing in more features!
Note: install using husky@latest to get the bug fixes that were released after.
👋 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
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.
After being in early access for Open Source projects and Sponsors for a limited time, I'm happy to announce that husky 6 is MIT again and can be freely used in commercial projects! 🎉
Many thanks to the Open Source projects and Companies which have switched to/sponsored the new husky during this period!
OSS is my full-time job, please consider sponsoring the development of husky on GitHub sponsors or Open Collective. Thank you!
Breaking change
husky init has been moved to its own package (npx husky-init)
Added
Programmatically use husky: require('husky')
TypeScript definitions
Migrating from husky 4
Husky 6 contains breaking changes. If you're coming from v4, npm install husky@6 won't be enough.
Recommended: see husky-4-to-6 CLI to automatically migrate your config. There's also a dedicated section in the docs.
Husky 5 is released under The Parity Public License.
It doesn't affect you if you're using husky in an Open Source project or if you're a sponsor. You're free to use it as usual and I hope you'll enjoy this new release ❤️
If you're using husky in a commercial project, you may want to consider becoming a sponsor to support the project. You can also try it for 30 days.
This is only for a limited time, husky will be MIT again later.
Migrating
Important Husky v5 brings a lot of improvements but is also very different from v4. Git hooks won't work if you only upgrade husky dependency, existing config needs to be migrated too.
The best way to switch to v5 is to follow the new installation instructions and migrate existing hooks command using husky add.
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 MR becomes conflicted, or you tick the rebase/retry checkbox.
🔕Ignore: Close this MR and you won't be reminded about this update again.
If you want to rebase/retry this MR, check this box
This MR contains the following updates:
| Package | Type | Update | Change |
|---|---|---|---|
| [husky](https://github.com/typicode/husky) | devDependencies | major | [`^4.2.3` -> `^9.0.0`](https://renovatebot.com/diffs/npm/husky/4.3.8/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 [@​btea](https://github.com/btea) in https://github.com/typicode/husky/pull/1383
- fix: `export HUSKY=0` in init (fixes [#​1393](https://github.com/typicode/husky/issues/1393)) by [@​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 [@​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 [@​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 [@​khaledYS](https://github.com/khaledYS) in https://github.com/typicode/husky/pull/1369
- Fix tab detection on install command by [@​glensc](https://github.com/glensc) in https://github.com/typicode/husky/pull/1376
- refactor: reduce file size by [@​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 [@​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 [@​rakleed](https://github.com/rakleed) in https://github.com/typicode/husky/pull/1354
- chore: apply editorconfig to code only by [@​typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1355
- docs: update install script to mjs and fix CI checks by [@​starnayuta](https://github.com/starnayuta) in https://github.com/typicode/husky/pull/1357
- Fix unbound variable by [@​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 [@​ManuelRauber](https://github.com/ManuelRauber) in https://github.com/typicode/husky/pull/1350
- fix: init error by [@​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 [@​typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1348
- refactor: simplify by [@​typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1349
- fix: init not working on pnpm [#​1334](https://github.com/typicode/husky/issues/1334) by [@​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 [@​typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1340
- chore: fix links in issue template by [@​julien-f](https://github.com/julien-f) in https://github.com/typicode/husky/pull/1341
- fix: add scripts field if not present by [@​chalkygames123](https://github.com/chalkygames123) in https://github.com/typicode/husky/pull/1338
- docs: changelog link by [@​typicode](https://github.com/typicode) in https://github.com/typicode/husky/pull/1343
- fix: insert final newline by [@​chalkygames123](https://github.com/chalkygames123) in https://github.com/typicode/husky/pull/1339
- fix: fix git hooks path on windows by [@​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 [@​gergelypap](https://github.com/gergelypap) in https://github.com/typicode/husky/pull/1336
- docs: typo by [@​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>
#### TLDR;
Improved user experience and a (even) smaller package size while packing in more features!
*Note: install using `husky@latest` to get the bug fixes that were released after.*
#### 👋 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 :slightly_smiling_face:
#### 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())
```
### [`v8.0.3`](https://github.com/typicode/husky/releases/tag/v8.0.3)
[Compare Source](https://github.com/typicode/husky/compare/v8.0.2...v8.0.3)
- fix: add git not installed message [#​1208](https://github.com/typicode/husky/issues/1208)
### [`v8.0.2`](https://github.com/typicode/husky/releases/tag/v8.0.2)
[Compare Source](https://github.com/typicode/husky/compare/v8.0.1...v8.0.2)
- docs: remove deprecated npm set-script
### [`v8.0.1`](https://github.com/typicode/husky/releases/tag/v8.0.1)
[Compare Source](https://github.com/typicode/husky/compare/v8.0.0...v8.0.1)
- fix: use POSIX equality operator
### [`v8.0.0`](https://github.com/typicode/husky/releases/tag/v8.0.0)
[Compare Source](https://github.com/typicode/husky/compare/v7.0.4...v8.0.0)
#### What's Changed
##### Feats
- feat: add `husky -` prefix to logged global error messages by [@​joshbalfour](https://github.com/joshbalfour) in https://github.com/typicode/husky/pull/1092
- feat: show `PATH` when command not found to improve debuggability
- feat: drop Node 12 support
- feat: skip install if `$HUSKY=0`
##### Fixes
- fix: hook script use `/usr/bin/env sh` instead of direct path of `sh` by [@​skhaz](https://github.com/skhaz) in https://github.com/typicode/husky/pull/1051
- fix: actually set 'husky_skip_init' as readonly in `./husky.sh` by [@​hyperupcall](https://github.com/hyperupcall) in https://github.com/typicode/husky/pull/1104
- fix: force `basename`/`dirname` to treat `$0` as an argument by [@​mataha](https://github.com/mataha) in https://github.com/typicode/husky/pull/1132
- fix: remove `git.io` links by [@​renbaoshuo](https://github.com/renbaoshuo) in https://github.com/typicode/husky/pull/1136
##### Docs
- docs: fix uninstall via npm by [@​pddpd](https://github.com/pddpd) in https://github.com/typicode/husky/pull/1033
- docs: add dog emoji as favicon by [@​jamiehaywood](https://github.com/jamiehaywood) in https://github.com/typicode/husky/pull/1095
- docs: replace deprecated `npx --no-install` option with `npx --no` by [@​sibiraj-s](https://github.com/sibiraj-s) in https://github.com/typicode/husky/pull/1070
- docs: add `pnpm` installation by [@​MohamadKh75](https://github.com/MohamadKh75) in https://github.com/typicode/husky/pull/1139
##### Chore
- chore: update workflows by [@​tiziodcaio](https://github.com/tiziodcaio) in https://github.com/typicode/husky/pull/1125
### [`v7.0.4`](https://github.com/typicode/husky/releases/tag/v7.0.4)
[Compare Source](https://github.com/typicode/husky/compare/v7.0.3...v7.0.4)
*No changes. Husky v7.0.3 was reverted, this version is the same as v7.0.2.*
### [`v7.0.3`](https://github.com/typicode/husky/compare/v7.0.2...v7.0.3)
[Compare Source](https://github.com/typicode/husky/compare/v7.0.2...v7.0.3)
### [`v7.0.2`](https://github.com/typicode/husky/releases/tag/v7.0.2)
[Compare Source](https://github.com/typicode/husky/compare/v7.0.1...v7.0.2)
Fix pre-commit hook in WebStorm ([#​1023](https://github.com/typicode/husky/issues/1023))
### [`v7.0.1`](https://github.com/typicode/husky/releases/tag/v7.0.1)
[Compare Source](https://github.com/typicode/husky/compare/v7.0.0...v7.0.1)
- Fix gracefully fail if Git command is not found [#​1003](https://github.com/typicode/husky/issues/1003) (same as in v6)
### [`v7.0.0`](https://github.com/typicode/husky/releases/tag/v7.0.0)
[Compare Source](https://github.com/typicode/husky/compare/v6.0.0...v7.0.0)
- Improve `.husky/` directory structure. **`.husky/.gitignore` is now unnecessary and can be removed**.
- Improve error output (shorter)
- Update [`husky-init`](https://github.com/typicode/husky-init) CLI
- Update [`husky-4-to-7`](https://github.com/typicode/husky-4-to-7) CLI
- Drop Node 10 support
*Please help me develop and release OSS projects :heart: on [GitHub Sponsors](https://github.com/sponsors/typicode) or [Open Collective](https://opencollective.com/husky). Thank you for your support!*
### [`v6.0.0`](https://github.com/typicode/husky/releases/tag/v6.0.0)
[Compare Source](https://github.com/typicode/husky/compare/v5.2.0...v6.0.0)
After being in early access for Open Source projects and Sponsors for a limited time, **I'm happy to announce that husky 6 is MIT again** and can be freely used in commercial projects! 🎉
**Many thanks to the [Open Source projects](https://typicode.github.io/husky/#/?id=used-by) and Companies which have switched to/sponsored the new husky during this period!**
*OSS is my full-time job, please consider sponsoring the development of husky on [GitHub sponsors](https://github.com/sponsors/typicode) or [Open Collective](https://opencollective.com/husky). Thank you!*
### Breaking change
- `husky init` has been moved to its own package (`npx husky-init`)
### Added
- Programmatically use husky: `require('husky')`
- TypeScript definitions
### Migrating from husky 4
Husky 6 contains breaking changes. If you're coming from v4, `npm install husky@6` won't be enough.
**Recommended:** see [husky-4-to-6](https://typicode.github.io/husky/#/?id=husky-4-to-6-cli) CLI to automatically migrate your config. There's also a dedicated section in the [docs](https://typicode.github.io/husky/#/?id=migrate-from-v4-to-v6).
**If you're curious why config has changed, you may be interested in reading:**
https://blog.typicode.com/husky-git-hooks-javascript-config/
**Also Husky 6 follows official [npm](https://docs.npmjs.com/cli/v7/using-npm/scripts#best-practices) and [Yarn](https://yarnpkg.com/advanced/lifecycle-scripts#a-note-about-postinstall) best practices regarding autoinstall.** It's recommended to use `prepare` script instead (see [usage](https://typicode.github.io/husky/#/?id=usage) in docs).
### [`v5.2.0`](https://github.com/typicode/husky/releases/tag/v5.2.0)
[Compare Source](https://github.com/typicode/husky/compare/v5.1.3...v5.2.0)
- Add `set` command to replace hooks (`husky set .husky/pre-commit cmd`)
- Update `add` command to append command (`husky add .husky/pre-commit cmd`)
- Improve error messages
### [`v5.1.3`](https://github.com/typicode/husky/releases/tag/v5.1.3)
[Compare Source](https://github.com/typicode/husky/compare/v5.1.2...v5.1.3)
- docs: add specific Yarn v2 install/uninstall instructions
- cli: `husky init` will detect Yarn v2 and initialize accordingly
### [`v5.1.2`](https://github.com/typicode/husky/releases/tag/v5.1.2)
[Compare Source](https://github.com/typicode/husky/compare/v5.1.1...v5.1.2)
- docs: recommend `prepare` script instead of `postinstall` ([#​890](https://github.com/typicode/husky/issues/890))
- cli: `husky init` use `prepare` script ([#​890](https://github.com/typicode/husky/issues/890))
### [`v5.1.1`](https://github.com/typicode/husky/releases/tag/v5.1.1)
[Compare Source](https://github.com/typicode/husky/compare/v5.1.0...v5.1.1)
- style(shell): add trailing newlines ([#​870](https://github.com/typicode/husky/issues/870))
- fix(init): update package.json postinstall
### [`v5.1.0`](https://github.com/typicode/husky/releases/tag/v5.1.0)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.9...v5.1.0)
- Add `husky init`
### [`v5.0.9`](https://github.com/typicode/husky/releases/tag/v5.0.9)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.8...v5.0.9)
- fix(install): do not fail if not inside a Git directory (closes [#​851](https://github.com/typicode/husky/issues/851))
See https://github.com/typicode/husky/releases/tag/v5.0.0 for v5 release notes
### [`v5.0.8`](https://github.com/typicode/husky/releases/tag/v5.0.8)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.7...v5.0.8)
- fix(install): better handle Git <2.9 ([#​846](https://github.com/typicode/husky/issues/846)) closes [#​844](https://github.com/typicode/husky/issues/844)
### [`v5.0.7`](https://github.com/typicode/husky/releases/tag/v5.0.7)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.6...v5.0.7)
- fix(shell): double quote params ([#​824](https://github.com/typicode/husky/issues/824))
### [`v5.0.6`](https://github.com/typicode/husky/releases/tag/v5.0.6)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.5...v5.0.6)
- Remove unused files
### [`v5.0.5`](https://github.com/typicode/husky/releases/tag/v5.0.5)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.4...v5.0.5)
- Fix custom directory support [#​827](https://github.com/typicode/husky/issues/827)
### [`v5.0.4`](https://github.com/typicode/husky/compare/v5.0.3...v5.0.4)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.3...v5.0.4)
### [`v5.0.3`](https://github.com/typicode/husky/compare/v5.0.2...v5.0.3)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.2...v5.0.3)
### [`v5.0.2`](https://github.com/typicode/husky/compare/v5.0.1...v5.0.2)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.1...v5.0.2)
### [`v5.0.1`](https://github.com/typicode/husky/compare/v5.0.0...v5.0.1)
[Compare Source](https://github.com/typicode/husky/compare/v5.0.0...v5.0.1)
### [`v5.0.0`](https://github.com/typicode/husky/releases/tag/v5.0.0)
[Compare Source](https://github.com/typicode/husky/compare/v4.3.8...v5.0.0)
👉 See https://typicode.github.io/husky for breaking changes and new installation instructions.
#### Note about the license
Husky 5 is released under The Parity Public License.
It doesn't affect you if you're using husky in an Open Source project or if you're a sponsor. You're free to use it as usual and I hope you'll enjoy this new release ❤️
If you're using husky in a commercial project, you may want to consider becoming a sponsor to support the project. You can also try it for 30 days.
**This is only for a limited time, husky will be MIT again later.**
#### Migrating
**Important** Husky v5 brings a lot of improvements but is also very different from v4. Git hooks won't work if you only upgrade husky dependency, existing config needs to be migrated too.
The best way to switch to v5 is to follow the new installation instructions and migrate existing hooks command using `husky add`.
</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 MR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 **Ignore**: Close this MR and you won't be reminded about this update again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box
---
This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMTEuMiIsInVwZGF0ZWRJblZlciI6IjM3LjIxMS4yIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIn0=-->
argoyle
(Migrated from gitlab.com)
merged commit e8571f31ed into master2024-02-23 22:06:07 +00:00
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
This MR contains the following updates:
^4.2.3->^9.0.0Release Notes
typicode/husky (husky)
v9.0.11Compare Source
package-lock.jsonby @btea in https://github.com/typicode/husky/pull/1383export HUSKY=0in init (fixes #1393) by @typicode in https://github.com/typicode/husky/pull/1395v9.0.10Compare Source
v9.0.9Compare Source
v9.0.8Compare Source
v9.0.7Compare Source
~/.huskyrccorrectly (compatibility with v8)v9.0.6Compare Source
v9.0.5Compare Source
v9.0.4Compare Source
v9.0.3Compare Source
v9.0.2Compare Source
v9.0.1Compare Source
Kicking off the year with an exciting update!
TLDR;
Improved user experience and a (even) smaller package size while packing in more features!
Note: install using
husky@latestto get the bug fixes that were released after.👋 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 initv8
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.
Adding a New Hook
v8
v9
Adding a hook is as simple as creating a file. This can be accomplished using your favorite editor, a script or a basic
echocommand. For example, on Linux/macOS:Further Size Reduction
v8was already the most compact Git hooks manager at approximately6kB.v9takes this a step further, reducing the size to just3kB, 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
--provenancefor safer publishing.$XDG_CONFIG_HOMEsupport. Move~/.huskyrcto~/.config/husky/init.shfor centralized configuration.husky install. Usehuskyorhusky some/dirfor the same functionality (deprecation notice to be added)..gitis missing; it now triggers a warning instead of failure.HUSKY_DEBUG=1withHUSKY=2for debugging.ESMfor module usage.How to Migrate
v9is backward compatible withv8, allowing you to freely upgrade and migrate your hooks later.Here are the steps to migrate:
package.json.husky/pre-commitNote:
shwill be used to run hooks, even if a shebang is set.If you were using
huskyas a module:v8.0.3Compare Source
v8.0.2Compare Source
v8.0.1Compare Source
v8.0.0Compare Source
What's Changed
Feats
husky -prefix to logged global error messages by @joshbalfour in https://github.com/typicode/husky/pull/1092PATHwhen command not found to improve debuggability$HUSKY=0Fixes
/usr/bin/env shinstead of direct path ofshby @skhaz in https://github.com/typicode/husky/pull/1051./husky.shby @hyperupcall in https://github.com/typicode/husky/pull/1104basename/dirnameto treat$0as an argument by @mataha in https://github.com/typicode/husky/pull/1132git.iolinks by @renbaoshuo in https://github.com/typicode/husky/pull/1136Docs
npx --no-installoption withnpx --noby @sibiraj-s in https://github.com/typicode/husky/pull/1070pnpminstallation by @MohamadKh75 in https://github.com/typicode/husky/pull/1139Chore
v7.0.4Compare Source
No changes. Husky v7.0.3 was reverted, this version is the same as v7.0.2.
v7.0.3Compare Source
v7.0.2Compare Source
Fix pre-commit hook in WebStorm (#1023)
v7.0.1Compare Source
v7.0.0Compare Source
.husky/directory structure..husky/.gitignoreis now unnecessary and can be removed.husky-initCLIhusky-4-to-7CLIPlease help me develop and release OSS projects ❤️ on GitHub Sponsors or Open Collective. Thank you for your support!
v6.0.0Compare Source
After being in early access for Open Source projects and Sponsors for a limited time, I'm happy to announce that husky 6 is MIT again and can be freely used in commercial projects! 🎉
Many thanks to the Open Source projects and Companies which have switched to/sponsored the new husky during this period!
OSS is my full-time job, please consider sponsoring the development of husky on GitHub sponsors or Open Collective. Thank you!
Breaking change
husky inithas been moved to its own package (npx husky-init)Added
require('husky')Migrating from husky 4
Husky 6 contains breaking changes. If you're coming from v4,
npm install husky@6won't be enough.Recommended: see husky-4-to-6 CLI to automatically migrate your config. There's also a dedicated section in the docs.
If you're curious why config has changed, you may be interested in reading:
https://blog.typicode.com/husky-git-hooks-javascript-config/
Also Husky 6 follows official npm and Yarn best practices regarding autoinstall. It's recommended to use
preparescript instead (see usage in docs).v5.2.0Compare Source
setcommand to replace hooks (husky set .husky/pre-commit cmd)addcommand to append command (husky add .husky/pre-commit cmd)v5.1.3Compare Source
husky initwill detect Yarn v2 and initialize accordinglyv5.1.2Compare Source
preparescript instead ofpostinstall(#890)husky initusepreparescript (#890)v5.1.1Compare Source
v5.1.0Compare Source
husky initv5.0.9Compare Source
See https://github.com/typicode/husky/releases/tag/v5.0.0 for v5 release notes
v5.0.8Compare Source
v5.0.7Compare Source
v5.0.6Compare Source
v5.0.5Compare Source
v5.0.4Compare Source
v5.0.3Compare Source
v5.0.2Compare Source
v5.0.1Compare Source
v5.0.0Compare Source
👉 See https://typicode.github.io/husky for breaking changes and new installation instructions.
Note about the license
Husky 5 is released under The Parity Public License.
It doesn't affect you if you're using husky in an Open Source project or if you're a sponsor. You're free to use it as usual and I hope you'll enjoy this new release ❤️
If you're using husky in a commercial project, you may want to consider becoming a sponsor to support the project. You can also try it for 30 days.
This is only for a limited time, husky will be MIT again later.
Migrating
Important Husky v5 brings a lot of improvements but is also very different from v4. Git hooks won't work if you only upgrade husky dependency, existing config needs to be migrated too.
The best way to switch to v5 is to follow the new installation instructions and migrate existing hooks command using
husky add.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 MR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this MR and you won't be reminded about this update again.
This MR has been generated by Renovate Bot.
mentioned in commit
e8571f31ed