Dropping bash script precommit in favor of using lint-staged #407
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
… roots so they work with lint-staged.
…local library config.
lukehb
approved these changes
Jan 16, 2025
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:
#406
The previous implementation of doing precommit linting had problems where you might have unstaged changes that fix lint errors. Then when the commit is pushed it fails remotely.
Solution
Instead of using a naive bash script to run the linter we now use lint-staged. Using lint-staged fixes the problem by only linting staged files so you cant commit things that will break linting rules.
In addition to better linting we now also run prettier over all json files being committed which also has a global config in the root of the project.