Replace Prettier with Biome #7441
Conversation
The Prettier challenge was a reward of $20 000 for a formatter written in Rust that passes 95% of the Prettier test suite. Biome won that: https://prettier.io/blog/2023/11/27/20k-bounty-was-claimed This PR does a "yarn biome migrate prettier" and tweaks the result so the formatting differences are minimal to Prettier 2.7.1 that is currently used. The performance of Prettier 3.4.2 is comparable to 2.7.1, and Biome is quite a bit faster than both of them: $ time -p yarn prettier ... wwwroot/test/Terria/applyInitData/MapServer/mapServerWithError.json 1ms Done in 19.41s. real 19.54 user 28.86 sys 2.23 $ time -p yarn format yarn run v1.22.22 $ biome format --write . Formatted 1376 files in 251ms. Fixed 70 files. Done in 0.35s. real 0.49 user 1.83 sys 0.27
| : [H] extends [true] | ||
| ? true | ||
| : false; | ||
| ? true |
There was a problem hiding this comment.
The formatting of ?: is consistent with Prettier version 3.4.2.
| @@ -146,8 +146,7 @@ class MapboxVectorTileCatalogItem extends MappableMixin( | |||
| } | |||
| } | |||
|
|
|||
| @computed | |||
| /** Convert traits into paint rules: | |||
| @computed /** Convert traits into paint rules: | |||
There was a problem hiding this comment.
Prettier 3.4.2 also has this problem. Split out the change that moves the JSDoc to #7440 so that can get merged now without having to update the formatter.
| @@ -190,7 +190,10 @@ export default class WebMapServiceCapabilities { | |||
| readonly [name: string]: CapabilitiesLayer; | |||
| }; | |||
|
|
|||
| private constructor(readonly xml: XMLDocument, readonly json: any) { | |||
| private constructor( | |||
There was a problem hiding this comment.
I don't appreciate that constructors with readonly parameters are split over multiple lines even when they fit with room to spare in a single line, but this formatting is also consistent with Prettier 3.4.2.
| "**/*.scss.d.ts", | ||
| "./wwwroot/third_party/*", | ||
| "doc/acknowledgements/attributions.md", | ||
| "./wwwroot/test/init/sdmx-abs.json" |
There was a problem hiding this comment.
This is a 1.7 MB file that hasn't been updated since 2017, so put it in the ignore list to not slow down the formatting that is done.
|
I changed from black + isort + flake8 to Ruff in another project, and while I've known that faster is always better, I underestimated the impact of the speedup on my general mood during development. It's a life changing experience when formatting/linting is instant. Trying to quantify instant: it takes between 0.1 and 0.4s to blink, so the formatting is almost completed if you blink after pressing enter to run the formatter. Despite my praise for instant formatting/linting, I think the outstanding big PRs (Webpack 5, TypeScript 5.7, React imports, TSification) should be merged before this PR to avoid needless merge conflicts. |
What this PR does
The Prettier challenge was a reward
of $20 000 for a formatter written
in Rust that passes 95% of the Prettier
test suite. Biome won that:
https://prettier.io/blog/2023/11/27/20k-bounty-was-claimed
This PR does a "yarn biome migrate prettier"
and tweaks the result so the formatting
differences are minimal to Prettier 2.7.1
that is currently used. The performance
of Prettier 3.4.2 is comparable to 2.7.1,
and Biome is quite a bit faster than both
of them:
For testing purposes, this PR has put the formatting changes in a separate commit so that can be dropped and the branch be rebased against latest main without merge conflicts. The formatting commit should be squashed into the first commit when this is about to get merged.
Test me
Run
yarn format, especially on other platforms than Linux.Checklist
doc/.