chore(ci): set prettier
action to run on PR to main
, fix format
#2764
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.
Background
Follow-up to #2758.
We have tested that the
prettier
workflow works and prevents merging code with incorrect formatting.Trying to commit unformatted code:
Fixing the mentioned errors after running
npm run prettier
:What this PR does
prettier
workflow run on any PR to themain
branchprettier
in CI against TS/JS-like files, but we should also lint any TypeScript in Markdown files as well to fit with our house style guide, and ournpm run prettier
script already runs against.
so we might as well fix these so people don't get a bunch of files to commit if they follow the instructions given in the comment whenprettier
fails.Why not autofix?
It's an anti-pattern- we should encourage devs to be running
prettier
themselves so they get in the habit of writing more conformant code and also modifying commits in CI is bad.