Auto-format YAML with prettier and pre-commit #2728
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.
Summary
In #2726, there was an issue with the book build due to incorrectly formatted YAML. @aleesteele and I suggested it would be a good idea to enforce YAML formatting since it is a tricky thing to hand-edit and book build failures are not super informative.
List of changes proposed in this PR (pull-request)
.prettierignore
file to restrict which files will be auto-formatted to only YAML. We can change this file as needed to include other file we would like to be auto-formatted.This combination of pre-commit and prettier is a very common workflow among open source projects.
What should a reviewer concentrate their feedback on?
There will be three commits on this repo:
Acknowledging contributors