chore: use biome to format JSON and JavaScript files #8280

ematipico · 2023-08-30T09:55:36Z

Changes

With this PR, I want to propose the usage of biome for format JSON and JS files instead of prettier.

Also, it proposed to remove the organize-imports-cli and use biome to do that.

Here's the benchmarks run on my machine.

Current format:ci command:

Benchmark 1: pnpm format:ci
  Time (abs ≡):        42.289 s               [User: 55.376 s, System: 7.550 s]

Format + organize imports of biome:

Benchmark 1: pnpm format:source
  Time (abs ≡):        404.7 ms               [User: 742.7 ms, System: 170.9 ms]

biome + prettier (we need to keep prettier to format yml, astro and md files):

Benchmark 1: pnpm format:ci
  Time (abs ≡):         2.402 s               [User: 2.658 s, System: 1.071 s]

This comes to a price though, having another tool inside the code base. Although, I think this is worth the price:

CI is going to be snappier and faster;
we removed organize-imports-cli, which was taking a lot of time to finish;
the action [ci] format is going to take way less time to apply the commit;

Testing

The current CI should pass.

Docs

N/A

changeset-bot · 2023-08-30T09:55:39Z

⚠️ No Changeset found

Latest commit: a09ee5a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

TKDev7 · 2023-08-31T16:06:10Z

It would be fantastic if biome can support md, yml and Astro so we can get rid of prettier altogether :D

ematipico · 2023-09-05T09:29:36Z

It would be fantastic if biome can support md, yml and Astro so we can get rid of prettier altogether :D

It could, yes u.u

Unfortunately, we're not there yet.

bluwy

Skimming through the changes they look fine to me. Have one comment below about tabs in json. Other than that it looks great! We should also follow-up and remove the [ci] format commit so they formatting is enforced in CI.

biome.json

natemoo-re · 2023-09-05T19:20:38Z

I'm in favor of this! Could you add ad0d2b0 to .git-blame-ignore-revs?

natemoo-re · 2023-09-05T19:23:57Z

Just a heads up that I also opened #8420, but we can merge either one first

JoshuaKGoldberg · 2023-09-07T14:00:53Z

we need to keep prettier to format yml, astro and md files

If you really want to be snazzy and fast for those files too, you could replace Prettier with dprint 😄 . And at that point you might as well replace Biome with dprint altogether, no?

A couple of interesting dprint references:

TKDev7 · 2023-09-07T14:40:24Z

@JoshuaKGoldberg Might as well use dprint for js/ts too 😁

Edit:

so perhaps dprint would be a better Prettier replacement altogether?

I somehow missed this…

JoshuaKGoldberg · 2023-09-07T15:04:17Z

Ha, my phrasing was rushed and odd. Edited for clarity. Thanks 😄

TKDev7 · 2023-09-07T15:08:21Z

Hmm looks like dprint doesn’t have an official plugin for formatting yaml or Astro.

dsherret · 2023-09-07T15:24:46Z

Hmm looks like dprint doesn’t have an official plugin for formatting yaml or Astro.

It's possible to use prettier in dprint for that (https://github.com/dprint/dprint-plugin-prettier). It will run faster than prettier because it executes prettier on multiple threads.

ematipico · 2023-09-16T09:06:02Z

I'm in favor of this! Could you add ad0d2b0 to .git-blame-ignore-revs?

I wanted to do that, but should we wait for the PR to be merged? I thought that when we merge the PR, GitHub creates a new commit.

bluwy · 2023-09-19T09:04:18Z

.git-blame-ignore-revs

+# New formatting using Biome
+07613b96bbe7a74179895c8cbe5f364133edd9ee


Yeah I think we should only do this after merging. The commit hash will change

bluwy · 2023-09-19T09:06:52Z

packages/integrations/lit/server.js

-import './server-shim.js';
 import { LitElementRenderer } from '@lit-labs/ssr/lib/lit-element-renderer.js';
 import * as parse5 from 'parse5';
+import './server-shim.js';


I think we need the import './server-shim.js'; to be first as it's side-effectful and presumably affects how @lit-labs/ssr/lib/lit-element-renderer.js is loaded, so the order matters.

They should honestly be in separate group if the order is important, any formatter would make this mistake

Yeah putting a space between the imports would be fine by me too. I guess if biome wants to be more cautious about this automatically, plain import '...' ordering should be left as-is.

jacobdalamb · 2023-09-30T03:56:00Z

Will biome also be added to the astro sites?

Princesseuh · 2023-09-30T07:18:50Z

Will biome also be added to the astro sites?

No, this is only for our own repo.

jacobdalamb · 2023-10-30T21:12:55Z

Why is this closed?

Princesseuh · 2023-10-30T21:20:41Z

Why is this closed?

Since Biome can't format a fair amount of our files, it feels weird to have multiple formatters with different styles and configs

ematipico · 2023-10-30T21:52:49Z

Why is this closed?

It seems there isn't enough interest and I don't want to keep the PR open. If someone else wants to open a new one, they are welcome

ematipico force-pushed the chore/use-biome-formatter branch 2 times, most recently from 7e5b975 to bd71c57 Compare August 30, 2023 10:13

github-actions bot removed the pkg: solid Related to Solid (scope) label Aug 30, 2023

ematipico force-pushed the chore/use-biome-formatter branch from bd71c57 to 6d35ba3 Compare August 30, 2023 10:49

ematipico force-pushed the chore/use-biome-formatter branch from 6d35ba3 to 8a7e4db Compare September 5, 2023 09:28

ematipico marked this pull request as ready for review September 5, 2023 09:29

ematipico requested a review from a team as a code owner September 5, 2023 09:29

ematipico force-pushed the chore/use-biome-formatter branch from 8a7e4db to c8d1892 Compare September 5, 2023 09:31

bluwy reviewed Sep 5, 2023

View reviewed changes

biome.json Outdated Show resolved Hide resolved

natemoo-re mentioned this pull request Sep 5, 2023

Update Prettier #8420

Merged

ematipico added 5 commits September 16, 2023 09:12

chore: use biome to format JSON and JavaScript files

07613b9

chore: rebase

a58cc96

chore: fix build

966bc2c

chore: fix regressions

3fd6055

chore: revert JSON changes with new options

6a3ce6c

ematipico force-pushed the chore/use-biome-formatter branch from e318892 to 6a3ce6c Compare September 16, 2023 08:21

chore: ignore commit

a09ee5a

bluwy reviewed Sep 19, 2023

View reviewed changes

jacobdalamb mentioned this pull request Oct 21, 2023

Add formatter and linter delucis/astro-badge#33

Closed

ematipico closed this Oct 30, 2023

bluwy deleted the chore/use-biome-formatter branch October 8, 2024 06:17

		# New formatting using Biome
		07613b96bbe7a74179895c8cbe5f364133edd9ee

Uh oh!

chore: use biome to format JSON and JavaScript files #8280

chore: use biome to format JSON and JavaScript files #8280

Uh oh!

Conversation

ematipico commented Aug 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Testing

Docs

Uh oh!

changeset-bot bot commented Aug 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

TKDev7 commented Aug 31, 2023

Uh oh!

ematipico commented Sep 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bluwy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

natemoo-re commented Sep 5, 2023

Uh oh!

natemoo-re commented Sep 5, 2023

Uh oh!

JoshuaKGoldberg commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TKDev7 commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JoshuaKGoldberg commented Sep 7, 2023

Uh oh!

TKDev7 commented Sep 7, 2023

Uh oh!

dsherret commented Sep 7, 2023

Uh oh!

ematipico commented Sep 16, 2023

Uh oh!

bluwy Sep 19, 2023

Choose a reason for hiding this comment

Uh oh!

bluwy Sep 19, 2023

Choose a reason for hiding this comment

Uh oh!

Princesseuh Sep 29, 2023

Choose a reason for hiding this comment

Uh oh!

bluwy Sep 29, 2023

Choose a reason for hiding this comment

Uh oh!

jacobdalamb commented Sep 30, 2023

Uh oh!

Princesseuh commented Sep 30, 2023

Uh oh!

jacobdalamb commented Oct 30, 2023

Uh oh!

Princesseuh commented Oct 30, 2023

Uh oh!

ematipico commented Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

ematipico commented Aug 30, 2023 •

edited

Loading

changeset-bot bot commented Aug 30, 2023 •

edited

Loading

ematipico commented Sep 5, 2023 •

edited

Loading

JoshuaKGoldberg commented Sep 7, 2023 •

edited

Loading

TKDev7 commented Sep 7, 2023 •

edited

Loading

ematipico commented Oct 30, 2023 •

edited

Loading