@repobuddy/biome
@repobuddy/biome ships two Biome configs as JSONC files. Each one sets the formatter and the
linter, so your biome.json only has to extend it.
Install
Section titled “Install”# npmnpm install -D @repobuddy/biome @biomejs/biome
# yarnyarn add -D @repobuddy/biome @biomejs/biome
# pnpmpnpm add -D @repobuddy/biome @biomejs/biomeThe package declares @biomejs/biome >= 2 as a peer dependency. Install Biome alongside it.
{ "extends": ["@repobuddy/biome"]}Choose a config
Section titled “Choose a config”| Import | File | Use it when | Reference |
|---|---|---|---|
@repobuddy/biome |
recommended.jsonc |
You want the default. Same as @repobuddy/biome/recommended. |
recommended |
@repobuddy/biome/recommended |
recommended.jsonc |
You want to name the config explicitly. | recommended |
@repobuddy/biome/performant |
performant.jsonc |
The code is performance-sensitive and some style rules get in the way. | performant |
To see every difference in one table, read recommended vs performant.
Support
Section titled “Support”| Area | Support | Source |
|---|---|---|
| Biome | @biomejs/biome >= 2 (peer dependency). Tested in this repository with 2.5.15. |
packages/biome/package.json |
| Config format | JSONC files, exported as ., ./recommended, and ./performant. |
packages/biome/package.json |
| Module format | Not applicable. The package contains no JavaScript. | packages/biome/package.json (files) |
| File types | Every file Biome processes, except **/.vscode/**/*.txt and **/*.md. |
recommended.jsonc, performant.jsonc |
| Formatter | Tabs, lf, line width 120, single quotes, semicolons as needed. |
both configs |
With the presets applied, Biome 2.5.15 picked up JavaScript, TypeScript, JSX/TSX, JSON, JSONC, CSS, GraphQL, Svelte,
Vue, Astro, and HTML files in a scratch project. It ignored .yaml and .md files. What Biome supports is Biome’s
decision; see the Biome documentation.
Not supported
Section titled “Not supported”- Biome 1.x. The peer range is
>= 2, and the configs use Biome 2 keys (assist,files.includes). - Markdown. Both configs exclude
**/*.md. Biome 2.5 does not process Markdown anyway, and the exclusion stays as a guard (see the comment inrecommended.jsonc). - YAML linting. Biome does not process
.yamlfiles, and the presets add nothing for them. This repository lints YAML with ESLint andeslint-plugin-yml(eslint.config.mjs). - Tuning for other tools. The presets do not configure ESLint, Prettier, or an editor.