chore(prettier): ignore package.json #255
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.
What:
Ignore
package.json
when formatting withprettier
to avoid conflicting with thenpm
/yarn
format.Why:
npm
andyarn
both formatpackage.json
in a common, opinionated way. Formatting JSON files withprettier
yields a different result. People using the populareditor.formatOnSave
feature in VSCode withprettier
integration (for example) will inadvertently reformatpackage.json
and clutter up commits going back and forth between the two formats any timenpm
oryarn
modifiespackage.json
. Other forms of automated formatting will also reveal the problem (evennpm run setup
as documented in this project's contributing guide). It looks likepackage.json
was most likely formatted withprettier
in 1b1fd1b.How:
package.json
to.prettierignore
package.json
to prevent future diffsChecklist:
See also:
Stop re-formatting package.json with Prettier and VSCode once and for all by Martin Hochel