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.

Sign up for GitHub

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

Jump to bottom

Update husky 8.0.3 → 9.0.11 (major) #336

Closed
wants to merge 1 commit into from
Closed

Update husky 8.0.3 → 9.0.11 (major) #336

wants to merge 1 commit into from

Conversation

depfu[bot]
Copy link
Contributor

@depfu depfu bot commented Jun 9, 2024 •
edited
Loading

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ husky (8.0.3 → 9.0.11) · Repo · Changelog

Release Notes

9.0.11

9.0.10

9.0.7

  • fix: typo and source ~/.huskyrc correctly (compatibility with v8)
  • docs: fix example by @typicode in #1363

9.0.6

9.0.5

9.0.1

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

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by more commits than we can show here.

Depfu Status

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands
@​depfu rebase
Rebases against your default branch and redoes this update
@​depfu recreate
Recreates this PR, overwriting any edits that you've made to it
@​depfu merge
Merges this PR once your tests are passing and conflicts are resolved
@​depfu cancel merge
Cancels automatic merging of this PR
@​depfu close
Closes this PR and deletes the branch
@​depfu reopen
Restores the branch and reopens this PR (if it's closed)
@​depfu pause
Ignores all future updates for this dependency and closes this PR
@​depfu pause [minor|major]
Ignores all future minor/major updates for this dependency and closes this PR
@​depfu resume
Future versions of this dependency will create PRs again (leaves this PR as is)

@depfu depfu bot added dependencies Pull requests that update a dependency file depfu labels Jun 9, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main-legacy-yarn-workspaces@15fc2c5). Learn more about missing BASE report.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@                      Coverage Diff                       @@
##             main-legacy-yarn-workspaces     #336   +/-   ##
==============================================================
  Coverage                               ?   86.86%           
==============================================================
  Files                                  ?       78           
  Lines                                  ?      860           
  Branches                               ?      191           
==============================================================
  Hits                                   ?      747           
  Misses                                 ?      108           
  Partials                               ?        5

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

@coveralls
Copy link

coveralls commented Jun 9, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 9438265259

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 85.531%
Totals Coverage Status
Change from base Build 9438048816: 0.0%
Covered Lines: 569
Relevant Lines: 649
💛 - Coveralls

@coveralls
Copy link

coveralls commented Jun 9, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 9438265516

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 85.531%
Totals Coverage Status
Change from base Build 9438048816: 0.0%
Covered Lines: 569
Relevant Lines: 649
💛 - Coveralls

@depfu depfu bot force-pushed the depfu/update/yarn/husky-9.0.11 branch from 21f7ea7 to 188fbba Compare June 10, 2024 21:11
@coveralls
Copy link

coveralls commented Jun 10, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 9455594395

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 85.531%
Totals Coverage Status
Change from base Build 9455325337: 0.0%
Covered Lines: 569
Relevant Lines: 649
💛 - Coveralls

@coveralls
Copy link

coveralls commented Jun 10, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 9455593833

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 85.531%
Totals Coverage Status
Change from base Build 9455325337: 0.0%
Covered Lines: 569
Relevant Lines: 649
💛 - Coveralls

@depfu Depfu
Copy link
Contributor Author

depfu bot commented Jul 24, 2024

Closed in favor of #340.

@depfu depfu bot closed this Jul 24, 2024
@depfu depfu bot deleted the depfu/update/yarn/husky-9.0.11 branch July 24, 2024 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file depfu
Milestone
No milestone
2 participants
@codecov-commenter @coveralls