chore(ci): added lint-staged as pre-commit hook #1360
Merged
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.
Description of your changes
As described in the linked issue, the current pre-commit hook was not linting & fixing issues on the staged files but instead was applying the fixes after the commit was made, thus defeating the purpose of the commit hook.
This PR, that fixes #1359, introduces a new developer dependency called
lint-staged
(7M+ downloads/mo) that helps run linting on staged files specifically. In addition to fixing the issue, this library also helps optimize the process by linting only the files/paths touched in the commit.How to verify this change
Checkout the repo, run
npm run init-environment
, then make a change that would result in a fix (i.e. extra spaces or extra;
) and try making a commit.Related issues, RFCs
Issue number: #1359
Checklist
Breaking change checklist
Is it a breaking change?: NO
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.