Add pre-commit hook that runs prettier #1699
Merged
+54
−0
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.
What's changed?
As a convenience, this PR adds a hook which checks the formatting of your files, formatting any which it’s safe to.
Implementation notes
I’ve copied the one I implemented in https://github.com/guardian/datawrapper-import/pull/12 and tweaked it to account for the differences between prettier and scalafmt.
In particular, the hook is careful not to overwrite any unstaged changes: if a file has both staged and unstaged changes, running a formatter on it could (if something goes wrong) cause you to lose changes that git is unaware of, and they might be difficult to recover.
To Test
git config --local core.hooksPath scripts/git-hooks
.