chore: review commit hooks #1345
Merged
Conversation
This file contains 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
✅ Deploy Preview for veda-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
3 tasks
AliceR
approved these changes
Jan 13, 2025
There was a problem hiding this comment.
Thank you @stephenkilbourn ! Both pre-commit and pre-push hook are working for me now 🎉
This will also close #1263 !
| @@ -25,6 +25,7 @@ | |||
| "lint": "yarn lint:scripts && yarn lint:css", | |||
| "lint:scripts": "eslint app/scripts/", | |||
| "lint:css": "stylelint 'app/styles/**/**' 'app/scripts/**/*.(js|ts|tsx|jsx)'", | |||
| "postinstall": "husky", | |||
There was a problem hiding this comment.
This will run after the install of veda-ui as a registry, which we don't want it. Do we need this @stephenkilbourn
There was a problem hiding this comment.
@hanbyul-here - ah, I didn't realize that was going to be a consideration. Looking further at the husky docs for the setup of yarn, we need that postinstall setup, but we also need to disable it before and after the npm publish setup:
{
"scripts": {
// Yarn doesn't support prepare script
"postinstall": "husky",
// Include this if publishing to npmjs.com
"prepack": "pinst --disable",
"postpack": "pinst --enable"
}
}
i'm adding those in a follow-up PR here: #1384
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.
Related Ticket: Close #1329
Description of Changes
It seems that there are some changes in both Husky and Yarn in how to make them play nicely together. Husky needs to be run once for each user before the package begins enforcing the git hooks. When it does that, you should see a new directory
.husky/_. Fornpmthis is done through a prepare script. Yarn doesn't support this, so Husky recommends apostinstallscript. https://typicode.github.io/husky/how-to.html#manual-setupI've added that script, as well as added a pre-push hook to run the type check and unit tests. That's easy to remove if contributors prefer pushing separate commits to fix/add tests, though.