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: bump up husky version to v9 #5694

Merged
merged 1 commit into from
Jan 26, 2024
Merged

chore: bump up husky version to v9 #5694

merged 1 commit into from
Jan 26, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 25, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
husky ^8.0.3 -> ^9.0.0 age adoption passing confidence

Release Notes

typicode/husky (husky)

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 - 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 Mend Renovate. View repository job log here.

@renovate renovate bot added the dependencies Pull requests that update a dependency file label Jan 25, 2024
Copy link

codecov bot commented Jan 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (59788aa) 64.36% compared to head (af45b93) 64.25%.

Additional details and impacted files
@@            Coverage Diff             @@
##           canary    #5694      +/-   ##
==========================================
- Coverage   64.36%   64.25%   -0.11%     
==========================================
  Files         296      296              
  Lines       18239    18239              
  Branches     1473     1472       -1     
==========================================
- Hits        11739    11720      -19     
- Misses       6331     6350      +19     
  Partials      169      169              
Flag Coverage Δ
server-test 70.57% <ø> (-0.13%) ⬇️
unittest 42.15% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

graphite-app bot commented Jan 26, 2024

Merge activity

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [husky](https://github.com/typicode/husky) | [`^8.0.3` -> `^9.0.0`](https://renovatebot.com/diffs/npm/husky/8.0.3/9.0.6) | [![age](https://developer.mend.io/api/mc/badges/age/npm/husky/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/husky/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/husky/8.0.3/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/husky/8.0.3/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>typicode/husky (husky)</summary>

### [`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 [typicode/husky#1354
-   chore: apply editorconfig to code only by [@&#8203;typicode](https://github.com/typicode) in [typicode/husky#1355
-   docs: update install script to mjs and fix CI checks by [@&#8203;starnayuta](https://github.com/starnayuta) in [typicode/husky#1357
-   Fix  unbound variable by [@&#8203;typicode](https://github.com/typicode) in [typicode/husky#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 [typicode/husky#1350
-   fix: init error by [@&#8203;typicode](https://github.com/typicode) in [typicode/husky#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 [typicode/husky#1348
-   refactor: simplify by [@&#8203;typicode](https://github.com/typicode) in [typicode/husky#1349
-   fix: init not working on pnpm [#&#8203;1334](https://github.com/typicode/husky/issues/1334) by [@&#8203;rozbo](https://github.com/rozbo) in [typicode/husky#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 [typicode/husky#1340
-   chore: fix links in issue template by [@&#8203;julien-f](https://github.com/julien-f) in [typicode/husky#1341
-   fix: add scripts field if not present by [@&#8203;chalkygames123](https://github.com/chalkygames123) in [typicode/husky#1338
-   docs: changelog link by [@&#8203;typicode](https://github.com/typicode) in [typicode/husky#1343
-   fix: insert final newline by [@&#8203;chalkygames123](https://github.com/chalkygames123) in [typicode/husky#1339
-   fix: fix git hooks path on windows by [@&#8203;rozbo](https://github.com/rozbo) in [typicode/husky#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)

#### What's Changed

-   fix: exit code by [@&#8203;gergelypap](https://github.com/gergelypap) in [typicode/husky#1336
-   docs: typo by [@&#8203;chalkygames123](https://github.com/chalkygames123) in [typicode/husky#1337

#### New Contributors

-   [@&#8203;gergelypap](https://github.com/gergelypap) made their first contribution in [typicode/husky#1336

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

### [`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!

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

```shell
npm pkg set scripts.prepare="husky install"
npm run prepare
npx husky add .husky/pre-commit "npm test"
```

##### v9

```shell
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

```shell
npx husky add  .husky/pre-commit "npm test"
git add --chmod=+x .husky/pre-commit # On Windows
```

##### v9

```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 🙌

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

```diff
{
  "scripts": {
-   "prepare": "husky install"
+   "prepare": "husky"
  }
}
```

`.husky/pre-commit`

```diff
- #!/usr/bin/env sh
- . "$(dirname -- "$0")/_/husky.sh"
npm test
```

</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 [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/toeverything/AFFiNE).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMzUuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEzNS4wIiwidGFyZ2V0QnJhbmNoIjoiY2FuYXJ5In0=-->
Copy link
Contributor Author

renovate bot commented Jan 26, 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.

@graphite-app graphite-app bot merged commit af45b93 into canary Jan 26, 2024
38 of 39 checks passed
@graphite-app graphite-app bot deleted the renovate/husky-9.x branch January 26, 2024 03:09
@Brooooooklyn Brooooooklyn restored the renovate/husky-9.x branch January 26, 2024 06:09
saranshisatgit pushed a commit to Meta-Root-Zones/AFFiNE that referenced this pull request Jan 28, 2024
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [husky](https://github.com/typicode/husky) | [`^8.0.3` -> `^9.0.0`](https://renovatebot.com/diffs/npm/husky/8.0.3/9.0.6) | [![age](https://developer.mend.io/api/mc/badges/age/npm/husky/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/husky/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/husky/8.0.3/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/husky/8.0.3/9.0.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>typicode/husky (husky)</summary>

### [`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 [@&toeverything#8203;rakleed](https://github.com/rakleed) in [typicode/husky#1354
-   chore: apply editorconfig to code only by [@&toeverything#8203;typicode](https://github.com/typicode) in [typicode/husky#1355
-   docs: update install script to mjs and fix CI checks by [@&toeverything#8203;starnayuta](https://github.com/starnayuta) in [typicode/husky#1357
-   Fix  unbound variable by [@&toeverything#8203;typicode](https://github.com/typicode) in [typicode/husky#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 [@&toeverything#8203;ManuelRauber](https://github.com/ManuelRauber) in [typicode/husky#1350
-   fix: init error by [@&toeverything#8203;typicode](https://github.com/typicode) in [typicode/husky#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 [@&toeverything#8203;typicode](https://github.com/typicode) in [typicode/husky#1348
-   refactor: simplify by [@&toeverything#8203;typicode](https://github.com/typicode) in [typicode/husky#1349
-   fix: init not working on pnpm [#&toeverything#8203;1334](https://github.com/typicode/husky/issues/1334) by [@&toeverything#8203;rozbo](https://github.com/rozbo) in [typicode/husky#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 [@&toeverything#8203;typicode](https://github.com/typicode) in [typicode/husky#1340
-   chore: fix links in issue template by [@&toeverything#8203;julien-f](https://github.com/julien-f) in [typicode/husky#1341
-   fix: add scripts field if not present by [@&toeverything#8203;chalkygames123](https://github.com/chalkygames123) in [typicode/husky#1338
-   docs: changelog link by [@&toeverything#8203;typicode](https://github.com/typicode) in [typicode/husky#1343
-   fix: insert final newline by [@&toeverything#8203;chalkygames123](https://github.com/chalkygames123) in [typicode/husky#1339
-   fix: fix git hooks path on windows by [@&toeverything#8203;rozbo](https://github.com/rozbo) in [typicode/husky#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)

#### What's Changed

-   fix: exit code by [@&toeverything#8203;gergelypap](https://github.com/gergelypap) in [typicode/husky#1336
-   docs: typo by [@&toeverything#8203;chalkygames123](https://github.com/chalkygames123) in [typicode/husky#1337

#### New Contributors

-   [@&toeverything#8203;gergelypap](https://github.com/gergelypap) made their first contribution in [typicode/husky#1336

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

### [`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!

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

```shell
npm pkg set scripts.prepare="husky install"
npm run prepare
npx husky add .husky/pre-commit "npm test"
```

##### v9

```shell
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

```shell
npx husky add  .husky/pre-commit "npm test"
git add --chmod=+x .husky/pre-commit # On Windows
```

##### v9

```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 🙌

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

```diff
{
  "scripts": {
-   "prepare": "husky install"
+   "prepare": "husky"
  }
}
```

`.husky/pre-commit`

```diff
- #!/usr/bin/env sh
- . "$(dirname -- "$0")/_/husky.sh"
npm test
```

</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 [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/toeverything/AFFiNE).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMzUuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEzNS4wIiwidGFyZ2V0QnJhbmNoIjoiY2FuYXJ5In0=-->
@renovate renovate bot deleted the renovate/husky-9.x branch August 6, 2024 05:39
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
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant