Fix: Migrate husky hooks to v9 format #701
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Runs automatically on npm install Creates .husky/_ directory (which is gitignored, hence needs this script to auto init on install)
package.json field not compatible with Husky v9 (was a v4 feature)
Split entries to avoid race conditions (https://github.com/lint-staged/lint-staged?tab=readme-ov-file#task-concurrency)
We want to run the whole test script if a file is change, not only on changed test files. Else we could introduce a failing change but if the right test file isn't staged, the test won't be run.
JustWaveThings
approved these changes
Mar 28, 2025
There was a problem hiding this comment.
I agree this will improve DX by getting those errors pre-commit. Thanks for doing this @MaoShizhong 🚀
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because
The current installed Husky version is v9 but
package.jsoncontains the old v4 way of setting hooks. This doesn't work in v9 solint-stagedwas never being run pre-commit. While we already have GH workflows for the same actions, it helps to have this at the local level too and reduce "appease linter/formatter" commits. Belts and braces.This PR
preparenpm script to ensurenpm installalso initialises husky (its setup files include a.gitignorethat ignores themselves) https://typicode.github.io/husky/how-to.html#manual-setuplint-stagedtasks for different file types to also include PrettierIssue
N/A
Additional Information
Example trying to commit a single change to
index.jsthat includes alet foo;somewhere.Current behaviour:
With PR fix:
Pull Request Requirements
location of change: brief description of changeformat, e.g.Callbacks command: Update verbiageBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection