Fix: broken Prettier configuration #850
Open
Conversation
This file contains 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
ryami333
commented
Aug 23, 2024
| @@ -5,23 +5,23 @@ | |||
|
|
|||
| version: 2 | |||
| updates: | |||
| - package-ecosystem: "pip" | |||
There was a problem hiding this comment.
This .github directory had been added to the .prettierignore file, so I removed it and formatted these files.
ryami333
commented
Aug 23, 2024
| - run: pnpm run prettier . --check | ||
| - run: pnpm prettier . --check |
There was a problem hiding this comment.
Using pnpm run implies use of a package.json script - whereas in this context we want the binary (we don't want to run prettier . --write).
ryami333
commented
Aug 23, 2024
| pnpm-lock.yaml |
There was a problem hiding this comment.
pnpm-lock.yaml is generated automatically by pnpm, and its formatting isn't prettier-compliant - we don't want to force developers to format it though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In
package.jsonthere was a script definition calledprettierwhich mapped toprettier . --write. This meant that whenever you would runpnpm prettier . --checkthe script would actually be evaluated asprettier . --write "." "--check", and as suchpnpm prettier . --checkwould never fail, because it would always just write the files in place.This means that a handful of files in the project have already been merged with incorrect formatting because the
pnpm run prettier . --checkstep in the test workflow was ineffective.