Invert .prettierignore (use opt-out, not opt-in) #1687
Merged
Conversation
This file contains hidden or 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
ddbeck
approved these changes
Aug 28, 2024
Collaborator
ddbeck
left a comment
ddbeck
left a comment
There was a problem hiding this comment.
Thank you, @queengooborg. This is a good fix. When we originally started using prettier it was only for the YAML files, so .prettierignore existed only to prevent editors from automatically formatting everything else. It makes sense now to flip it around.
One nit in a line comment, but otherwise ready to go.
ddbeck
added
the
tools and infrastructure
Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>
Contributor
Author
|
Formatting of all the remaining files will soon follow as well! |
ddbeck
approved these changes
Aug 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR inverts the direction of the
.prettierignorefile, so that it lists the files and folders to ignore (as the file name implies), rather than all the files and folders to only format.Motivation
In another PR (my first), the first review comment had requested that the new script was added to the
.prettierignorefile as an opt-in. However, it is not standard to use a.ignorefile for opting into formatting, so this was very confusing to me. Additionally, since I'm assuming the plan is to eventually format all files using Prettier, having the.prettierignorefile use an opt-out (or using proper terminology, ignore) structure, it serves as a to-do list for what still needs to be formatted.