Adopt Biome with @repobuddy/biome

Add Biome to a project, extend a preset, and fix the first run’s findings.

Steps

Install both packages.

# pnpm (use npm install -D or yarn add -D for the others)
pnpm add -D @biomejs/biome @repobuddy/biome

The package needs @biomejs/biome >= 2.

Create biome.json and extend a preset. See Choose a config.

{
  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
  "extends": ["@repobuddy/biome"],
  "vcs": {
    "enabled": true,
    "clientKind": "git",
    "useIgnoreFile": true
  }
}

vcs makes Biome skip files that .gitignore ignores. It is optional.

Add scripts to package.json.

{
  "scripts": {
    "check": "biome check",
    "check:fix": "biome check --write",
    "format": "biome format --write"
  }
}

Run the check.
Terminal window
```
pnpm check
```
Biome lints, checks formatting, and checks import order in one pass. It exits 1 when any error remains.
Apply the safe fixes.
Terminal window
```
pnpm check:fix
```

Fix what remains by hand, or suppress one case with a comment.

// biome-ignore lint/suspicious/noConsole: CLI output
console.log('done')

What to expect on the first run

With recommended:

Formatting differences in many files: tabs, single quotes, no semicolons, line width 120. --write fixes them.
Unsorted imports, from the organizeImports assist. --write fixes them.
Unused imports, which the config marks error with a safe fix. --write removes them.
import 'fs' rewritten to import 'node:fs' (useNodejsImportProtocol).
console.log calls (noConsole). Replace them with console.info or another allowed method.
Unused variables and parameters. noUnusedVariables is an error; Biome’s unsafe fix prefixes the name with an underscore, so review the change.

With performant, expect the same formatting differences (with trailing commas removed), but no import sorting, no console.log findings, and unused imports as warnings.

To fail on warnings too (for CI), add --error-on-warnings:

biome check --error-on-warnings

Finished config

{
  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
  "extends": ["@repobuddy/biome"],
  "vcs": { "enabled": true, "clientKind": "git", "useIgnoreFile": true }
}

Verify

Run pnpm check. It reports Checked N files and exits 0 once the findings are fixed.

Adopt Biome with @repobuddy/biome

Steps

What to expect on the first run

Finished config

Verify

Related