Support Biome as formatter

[jase88]

• I'd be willing to implement this feature (contributing guide)

Description

Biome (previously Rome) made some news by reaching 97% compatibility with Prettier.
A lot of rules from major plugins are already supported.

Motivation

It would be beneficial performance-wise.
And by making the formatter plugable it would make nx even more future-proof.

Suggested Implementation

official biome support with:

• migration from prettier configuration to biome config
• generator to provide configuration per project
• executor for running nx format with biome formatter

Alternate Implementations

• provide an API to make formatting via plugin possible

[vaibhavdugar]

How to use biome in nx monorepo?

[guillempuche]

@vaibhavdugar, I have a repo for this https://github.com/guillempuche/nx-expo-next-tamagui/blob/main/biome.json

I still need to run lint for all the files (as @JamesHenry pointed guillempuche/nx-expo-next-tamagui#1), but when coding a file on VSCode, it works.

[vaibhavdugar]

@guillempuche in your repo as well biome is not configured with nx, I see that you are also using ESLint with nx, do you have any idea how can we use biome instead of ESLint in nx.json?

[guillempuche]

There aren't Eslint nor Prettier dependencies in the root package.json.

It's all Biome.

I don't use Nx target lint (I should delete this). Instead, you can format the code via the script in package.json. There's also a pre-commit Husky script.

[vaibhavdugar]

Thanks, can you tell me how to run the biome command for linting to catch all the errors?

[guillempuche]

Two ways:

a) yarn lint and it alerts you for errors
b) commit a change, auto lint and it alerts you for errors. How? Husky runs yarn pre-commit that triggers dependency lint-staged https://github.com/guillempuche/nx-expo-next-tamagui/blob/main/.lintstagedrc

[MrChrisRodriguez]

We just updated our lint target as follows:

"lint": {
      "executor": "nx:run-commands",
      "options": {
          "command": "yarn dlx @biomejs/biome check --apply {projectRoot}"
      }
    },

[shinebayar-g]

We use https://nx.dev/features/enforce-module-boundaries. I guess we'll wait until nx officially supports biome.

[jase88]

Biome has also a issue about monorepos: biomejs/biome#2228 aiming to support a root configuration that is extendable per project.

[mcfdez]

Hello friends,

I am working on this project https://github.com/GitOpsLovers/nx-biome to create a plugin to implement Biome as linter, executor and generator in NX. Who wants to participate is welcome!

[guillempuche]

@mcfdez , how does it support child biome.json files https://biomejs.dev/guides/big-projects/?

[mcfdez]

@mcfdez , how does it support child biome.json files https://biomejs.dev/guides/big-projects/?

Hi @guillempuche

The idea is that the plugin configuration generator will create a biome.json in the project that you tell it and also creates a biome.json in the workspace root. In the biome.js of the project, an extend will be made.