Add pre-commit hook for prettier:write script #7896
Closed
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.
Overview
This PR adds a git pre-commit hook to automatically run the
prettier:writescript before code commits. This improvement was implemented because many team members were experiencing failed GitHub Actions due to prettier check failures when submitting PRs. By automating the formatting process at commit time, we can prevent these failures and improve the development workflow.Key Changes
huskyandlint-stagedpackagesDetailed Description
Installed Packages
Configuration Files
package.json:
preparescript:"prepare": "husky && chmod +x .husky/*"yarn install, husky is automatically installed and hook files are granted execution permissions..husky/pre-commit:
yarn lint-stagedcommand before commits.lintstagedrc.json:
{ "**/*.{ts,tsx,css}": ["yarn prettier:write"] }