Adding a pre commit check for npm libraries #379
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
lukehb
reviewed
Dec 20, 2024
lukehb
reviewed
Dec 20, 2024
| "pre-commit-lint" | ||
| ], | ||
| "dependencies": { |
There was a problem hiding this comment.
Should be dev-dependency, right?
lukehb
reviewed
Dec 20, 2024
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.
Relevant components:
Problem statement:
It's common to commit your work and build a PR only to later realise you forgot to run lint checks and the github actions fail, sometimes after a long while. This can lead to wasted time and frustrations.
Solution
This installs a git pre-commit hook that will cycle through the npm libraries and if there are staged files in them it will run lint allowing you to get earlier notification of any linting issues before you actually commit. This should help reduce the number of "Fixing linting issues" commits.
This uses an npm package
pre-commitin the root package.json which should automatically install the pre-commit hooks when you first do annpm i.