Biome

https://next.biomejs.dev/guides/
Admin
Biome is a fast and performant toolchain for web projects, providing formatting and linting for...
Tokens:21,901
Snippets:168
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Biome with Homebrew

Source: https://next.biomejs.dev/guides/manual-installation

Installs Biome via Homebrew on macOS and Linux.

```bash
brew install biome
```

--------------------------------

### Install Biome v2.0.6 with bun

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Install the exact version 2.0.6 of Biome using bun. Use --exact to pin the version.

```bash
bun add --dev --exact @biomejs/biome@2.0.6
```

--------------------------------

### Example ESLint configuration

Source: https://next.biomejs.dev/guides/migrate-eslint-prettier

Example ESLint configuration that the migration command reads. It uses the legacy format with extends, plugins, ignore_patterns, globals, rules, and overrides.

```json
{
  "extends": ["plugin:unicorn/recommended"],
  "plugins": ["unicorn"],
  "ignore_patterns": ["dist/**"],
  "globals": {
    "Global1": "readonly"
  },
  "rules": {
    "eqeqeq": "error"
  },
  "overrides": [
    {
      "files": ["tests/**"],
      "rules": {
        "eqeqeq": "off"
      }
    }
  ]
}
```

--------------------------------

### Install Biome on Arch Linux via pacman

Source: https://next.biomejs.dev/guides/manual-installation

Configures the Arch Linux Extra repository and installs Biome using pacman.

```ini
[extra]
Include = /etc/pacman.d/mirrorlist
```

```bash
pacman -S biome
```

--------------------------------

### Install Biome with Winget

Source: https://next.biomejs.dev/guides/manual-installation

Installs Biome via the community-maintained Winget package on Windows.

```powershell
winget install biomejs.biome
```

--------------------------------

### Configure files.includes and linter.includes

Source: https://next.biomejs.dev/guides/configure-biome

Configuration example showing how to include only `.js` files in `src/` and `test/`, exclude `.min.js` files globally, and refine linter includes to ignore `test/`. The `files.includes` field applies to all tools, and tool-specific `includes` can further refine.

```json
{
  "files": {
    "includes": ["src/**/*.js", "test/**/*.js", "!**/*.min.js"]
  },
  "linter": {
    "includes": ["**", "!test/**"]
  }
}
```

--------------------------------

### Install Biome v2.0.6 with yarn

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Install the exact version 2.0.6 of Biome using yarn. Use --exact to pin the version.

```bash
yarn add --dev --exact @biomejs/biome@2.0.6
```

--------------------------------

### Install Biome v2.0.6 with npm

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Install the exact version 2.0.6 of Biome using npm. Use --save-exact to pin the version.

```bash
npm install --save-dev --save-exact @biomejs/biome@2.0.6
```

--------------------------------

### Install Biome v2.0.6 with deno

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Install the exact version 2.0.6 of Biome using deno. Use --dev to add as a dev dependency.

```bash
deno add --dev npm:@biomejs/biome@2.0.6
```

--------------------------------

### Install Biome on Linux/macOS via curl installer

Source: https://next.biomejs.dev/guides/manual-installation

Installs the latest stable Biome binary on Linux and macOS to ${XDG_BIN_HOME:-$HOME/.local/bin} and adds it to PATH. The second command installs a specific version (2.5.9) using --version. You may need to restart your shell after installation.

```bash
curl -fsSL https://biomejs.dev/install | bash
```

```bash
curl -fsSL https://biomejs.dev/install | bash -s -- --version 2.5.9
```

--------------------------------

### Install Biome on Windows via PowerShell installer

Source: https://next.biomejs.dev/guides/manual-installation

Installs the latest stable Biome binary on Windows to %LOCALAPPDATA%\Biome\bin and adds it to user and current process PATH. The second command sets BIOME_VERSION to 2.5.9 before running the installer.

```powershell
irm https://biomejs.dev/install.ps1 | iex
```

```powershell
$env:BIOME_VERSION = "2.5.9"
irm https://biomejs.dev/install.ps1 | iex
```

--------------------------------

### biome.json with linter domains and recommended rules

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Example biome.json configuration file that enables all linter domains (next, react, test, solid, project) and sets recommended rules to true. This is a limited workaround for the removed 'all' option, but note that react and solid domains enable conflicting rules.

```json
{
  "linter": {
    "domains": {
      "next": "all",
      "react": "all",
      "test": "all",
      "solid": "all",
      "project": "all"
    },
    "rules": {
      "recommended": true
    }
  }
}
```

--------------------------------

### Neovim LSP configuration for Biome configuration path

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Example Neovim settings to set the configuration path for Biome LSP, replacing the removed --config-path option.

```json
{
  "biome.lsp": {
    "configurationPath": "./frontend/biome.json"
  }
}
```

--------------------------------

### Install Biome standalone executable

Source: https://next.biomejs.dev/guides/getting-started

Install Biome as a standalone executable without requiring Node.js. Use the appropriate command for macOS/Linux or Windows PowerShell.

```bash
# macOS and Linux
curl -fsSL https://biomejs.dev/install | bash


# Windows PowerShell
irm https://biomejs.dev/install.ps1 | iex
```

--------------------------------

### Install Biome v2.0.6 with pnpm

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Install the exact version 2.0.6 of Biome using pnpm. Use --save-exact to pin the version.

```bash
pnpm add --save-dev --save-exact @biomejs/biome@2.0.6
```

--------------------------------

### VSCode LSP configuration for Biome configuration path

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Example VSCode settings to set the configuration path for Biome LSP, replacing the removed --config-path option.

```json
{
  "lsp": {
    "biome": {
      "settings": {
         "configuration_path": "./frontend/biome.json"
      }
    }
  }
}
```

--------------------------------

### Use Biome Docker image for linting and formatting

Source: https://next.biomejs.dev/guides/manual-installation

Shows the official Docker image tags for Biome (major, major.minor, major.minor.patch) and example commands to lint and format files. The default workdir is /code.

```docker
ghcr.io/biomejs/biome:{major}
ghcr.io/biomejs/biome:{major}.{minor}
ghcr.io/biomejs/biome:{major}.{minor}.{patch}
```

```bash
# Lint files
docker run -v $(pwd):/code ghcr.io/biomejs/biome lint
docker run -v $(pwd):/code ghcr.io/biomejs/biome lint --write


# Format files
docker run -v $(pwd):/code ghcr.io/biomejs/biome format
docker run -v $(pwd):/code ghcr.io/biomejs/biome format --write
```

--------------------------------

### package.json with check script

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Example package.json file for the @org/ui package, with a check script that runs 'biome check'. This is used to illustrate how Biome resolves configuration files relative to the working directory.

```json
{
  "name": "@org/ui",
  "publish": false,
  "scripts": {
    "check": "biome check"
  }
}
```

--------------------------------

### Install Biome with npm, pnpm, bun, deno, or yarn

Source: https://next.biomejs.dev/guides/getting-started

Install Biome as a development dependency using various package managers. The -E flag pins the version of Biome, which is important for versioning consistency.

```bash
npm i -D -E @biomejs/biome
```

```bash
pnpm add -D -E @biomejs/biome
```

```bash
bun add -D -E @biomejs/biome
```

```bash
deno add -D npm:@biomejs/biome
```

```bash
yarn add -D -E @biomejs/biome
```

--------------------------------

### Exclude files via configuration with negated patterns

Source: https://next.biomejs.dev/guides/configure-biome

Configuration example using `files.includes` with negated patterns: `!` to ignore from linting/formatting and `!!` to ignore from project-related operations (indexing). The `**` pattern must precede negated globs.

```json
{
  "files": {
    "includes": [
      "**",
      "!**/*.generated.js",
      "!!**/dist"
    ]
  }
}
```

--------------------------------

### Import and export with assert and with syntax

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Code examples showing the old 'assert' syntax (no longer supported) and the new 'with' syntax for import and export statements. The 'with' syntax is supported in all LTS Node.js versions, browsers, and serverless runtimes.

```javascript
import {test} from "foo.json" assert { for: "for" }
export * from "mod" assert { type: "json" }
import {test} from "foo.json" with { for: "for" }
export * from "mod" with { type: "json" }
```

--------------------------------

### Reference shared Biome configuration in biome.json extends

Source: https://next.biomejs.dev/guides/publish-packages

Adds '@org/shared-configs/biome' to the extends array in biome.json. Biome resolves the package from the working directory; paths starting with '.' or ending with '.json' or '.jsonc' are treated as relative and not resolved from node_modules/.

```json
{
  "extends": ["@org/shared-configs/biome"]
}
```

--------------------------------

### Comment out cyclic-reference plugins in eslint.config.js

Source: https://next.biomejs.dev/guides/migrate-eslint-prettier

Example eslint.config.js with problematic plugin entries commented out to work around cyclic reference errors when migrating to Biome. Comment out the entries that may cause cyclic references, run the migration, then restore them and manually configure rules in biome.json.

```javascript
import { defineConfig } from 'eslint';
import jsxA11y from 'eslint-plugin-jsx-a11y';
import react from '@eslint-react/eslint-plugin';
import stylistic from '@stylistic/eslint-plugin';
import tsEslint from 'typescript-eslint';

export default defineConfig([
  react.configs.recommended,   // may cause cyclic reference
  jsxA11y.flatConfigs.recommended, // may cause cyclic reference
  // react.configs.recommended,
  // jsxA11y.flatConfigs.recommended,
  {
    plugins: {
      '@stylistic': stylistic,           // may cause cyclic reference
      '@typescript-eslint': tsEslint.plugin, // may cause cyclic reference
      // '@stylistic': stylistic,
      // '@typescript-eslint': tsEslint.plugin,
    },
  }
]);
```

--------------------------------

### Initialize Biome configuration with npx, pnpx, bunx, deno, or yarn

Source: https://next.biomejs.dev/guides/getting-started

Generate a biome.json configuration file using the init command with various package managers. Biome can run with zero configuration, but this command helps tweak settings.

```bash
npx @biomejs/biome init
```

```bash
pnpx @biomejs/biome init
```

```bash
bunx --bun @biomejs/biome init
```

```bash
deno run -A npm:@biomejs/biome init
```

```bash
yarn exec biome -- init
```

--------------------------------

### Format test folder with configuration

Source: https://next.biomejs.dev/guides/configure-biome

Run `biome format test/` to format files matching the configured includes. Only `.js` files not ending in `.min.js` are formatted; `src/` is not formatted because it is not listed in the CLI.

```bash
biome format test/
```

--------------------------------

### Run Biome migrate with deno

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Run the migrate command using deno. Use --write to apply changes.

```bash
deno run -A npm:@biomejs/biome migrate --write
```

--------------------------------

### Run Biome migrate with bunx

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Run the migrate command using bunx. Use --write to apply changes.

```bash
bunx --bun @biomejs/biome migrate --write
```

--------------------------------

### Create biome-manifest.json with multiple configurations

Source: https://next.biomejs.dev/guides/publish-packages

Defines the manifest with a version and a list of configurations. Each configuration maps a name to a file path. The version field is required.

```json
{
  "version": 1,
  "configs": [
    { "recommended": "./configs/recommended.json" },
    { "strict": "./configs/strict.json" }
  ]
}
```

--------------------------------

### Run Biome migrate with pnpx

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Run the migrate command using pnpx. Use --write to apply changes.

```bash
pnpx @biomejs/biome migrate --write
```

--------------------------------

### Run migration commands for ESLint and Prettier

Source: https://next.biomejs.dev/guides/migrate-eslint-prettier

Run these commands to migrate both ESLint and Prettier configurations to Biome. The commands overwrite your existing Biome configuration.

```bash
biome migrate eslint --write
biome migrate prettier --write
```

--------------------------------

### Run Biome migrate with npx

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Run the migrate command to update the configuration to mitigate breaking changes. Use --write to apply changes.

```bash
npx @biomejs/biome migrate --write
```

--------------------------------

### biome.json with includes glob relative to config file

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Example biome.json configuration file with a files.includes glob 'src/**'. In v2, this glob is relative to the configuration file, so it matches files in the config's directory, not the working directory.

```json
{
  "files": {
    "includes": ["src/**"]
  }
}
```

--------------------------------

### Run Biome migrate with yarn

Source: https://next.biomejs.dev/guides/upgrade-to-biome-v2

Run the migrate command using yarn. Use --write to apply changes.

```bash
yarn exec biome -- migrate --write
```

--------------------------------

### Export a local lint rule in a Biome manifest

Source: https://next.biomejs.dev/guides/publish-packages

First set up a Biome manifest with an empty plugins.rules array. Then add a sample rule mapping, update package.json to include the manifest and rule files, and finally enable the rule in a consumer's Biome configuration.

```json
{
  "version": 1,
  "plugins": {
    "rules": []
  }
}

```

```json
{
  "version": 1,
  "plugins": {
    "rules": [
      { "useCompanyLogger": "./rules/useCompanyLogger.grit" }
    ]
  }
}

```

```json
{
  "name": "@org/biome-plugins",
  "version": "1.0.0",
  "files": [
    "biome-manifest.json",
    "rules"
  ],
  "exports": {
    "biome": "./biome-manifest.json"
  }
}

```

```json
{
  "plugins": ["@org/biome-plugins/useCompanyLogger"]
}

```

--------------------------------

### Omit root false with extends //

Source: https://next.biomejs.dev/guides/big-projects

Shows that when using the microsyntax "extends": "//", the "root": false field can be omitted because it is implied. This example omits "root": false and still disables the formatter.

```json
{
   "root": false,
    "extends": "//",
    "formatter": {
      "enabled": false
    }
}
```

--------------------------------

### Lint test folder with configuration

Source: https://next.biomejs.dev/guides/configure-biome

Run `biome lint test/` to lint files in `test/`. No files are linted because the linter includes explicitly ignore the `test/` folder.

```bash
biome lint test/
```

--------------------------------

### Enable VCS integration with vcs.enabled and vcs.clientKind

Source: https://next.biomejs.dev/guides/integrate-in-vcs

Enables the VCS integration for Git. This configuration alone does not activate any features; you must opt-in to specific features like useIgnoreFile or defaultBranch.

```json
{
  "vcs": {
    "enabled": true,
    "clientKind": "git"
  }
}
```

--------------------------------

### Create nested biome.json files with extends //

Source: https://next.biomejs.dev/guides/big-projects

Two nested configuration files for packages/logger and packages/generate. Both set "root": false and use the "extends": "//" microsyntax to inherit from the root configuration. The first disables the noConsole rule; the second disables the formatter for code-generated files.

```json
{
    "root": false,
    "extends": "//",
    "linter": {
        "rules": {
            "suspicious": {
                "noConsole": "off"
            }
        }
    }
}
```

```json
{
    "root": false,
    "extends": "//",
    "formatter": {
        "enabled": false
    }
}
```

--------------------------------

### Manually download Biome binary for macOS, Linux, or Windows

Source: https://next.biomejs.dev/guides/manual-installation

Downloads the Biome executable for macOS arm, Linux x64, or Windows x64 from the latest CLI release on GitHub and grants execution permission. After downloading, run ./biome to use Biome.

```bash
# macOS arm (M1 or newer)
curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.5.15/biome-darwin-arm64 -o biome
chmod +x biome


# Linux (x86_64)
curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.5.15/biome-linux-x64 -o biome
chmod +x biome


# Windows (x86_64, Powershell)
Invoke-WebRequest -Uri "https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.5.15/biome-win32-x64.exe" -OutFile "biome.exe"
```

--------------------------------

### Biome CLI commands with bunx

Source: https://next.biomejs.dev/guides/getting-started

Use the Biome CLI with bunx to format, lint, and check code. The --write flag applies changes, and you can target specific files by replacing <files>.

```bash
# Format all files
bunx --bun @biomejs/biome format --write


# Format specific files
bunx --bun @biomejs/biome format --write <files>


# Lint and apply safe fixes to all files
bunx --bun @biomejs/biome lint --write


# Lint files and apply safe fixes to specific files
bunx --bun @biomejs/biome lint --write <files>


# Format, lint, and organize imports of all files
bunx --bun @biomejs/biome check --write


# Format, lint, and organize imports of specific files
bunx --bun @biomejs/biome check --write <files>
```

--------------------------------

### Biome CLI commands with deno

Source: https://next.biomejs.dev/guides/getting-started

Use the Biome CLI with deno to format, lint, and check code. The --write flag applies changes, and you can target specific files by replacing <files>.

```bash
# Format specific files
deno run -A npm:@biomejs/biome format --write <files>


# Format all files
deno run -A npm:@biomejs/biome format --write


# Lint files and apply safe fixes to all files
deno run -A npm:@biomejs/biome lint --write


# Lint files and apply safe fixes to specific files
deno run -A npm:@biomejs/biome lint --write <files>


# Format, lint, and organize imports of all files
deno run -A npm:@biomejs/biome check --write


# Format, lint, and organize imports of specific files
deno run -A npm:@biomejs/biome check --write <files>
```

--------------------------------

### Extend a published Biome configuration

Source: https://next.biomejs.dev/guides/publish-packages

Shows how to extend a configuration from a published package by adding the package path to the extends array.

```json
{
  "extends": ["@org/biome-configs/configs/strict"]
}
```

--------------------------------

### Run biome migrate eslint with various package managers

Source: https://next.biomejs.dev/guides/migrate-eslint-prettier

Run the migration command with different package managers. The command reads your ESLint configuration and overwrites your Biome configuration.

```bash
npx @biomejs/biome migrate eslint --write
```

```bash
pnpx @biomejs/biome migrate eslint --write
```

```bash
bunx --bun @biomejs/biome migrate eslint --write
```

```bash
deno run -A npm:@biomejs/biome migrate eslint --write
```

```bash
yarn exec biome -- migrate eslint --write
```

--------------------------------

### Format files via CLI

Source: https://next.biomejs.dev/guides/configure-biome

Use the `biome format` command with file and folder arguments. Folders are recursively traversed. Glob patterns are expanded by the shell, not by Biome, so some shells may not support `**`.

```bash
biome format file1.js src/
```

--------------------------------

### Run biome migrate eslint with --include-inspired

Source: https://next.biomejs.dev/guides/migrate-eslint-prettier

Run the migration command with the --include-inspired flag to also migrate inspired rules. By default, inspired rules are not migrated.

```bash
npx @biomejs/biome migrate eslint --write --include-inspired
```

```bash
pnpx @biomejs/biome migrate eslint --write --include-inspired
```

```bash
bunx --bun @biomejs/biome migrate eslint --write --include-inspired
```

```bash
deno run -A npm:@biomejs/biome migrate eslint --write --include-inspired
```

```bash
yarn exec biome -- migrate eslint --write --include-inspired
```

--------------------------------

### Configure package.json for publishing Biome configurations

Source: https://next.biomejs.dev/guides/publish-packages

Adds the manifest and configs to the files field and maps the biome export to the manifest. This is required for consumers to access the configurations.

```json
{
  "name": "@org/biome-configs",
  "version": "1.0.0",
  "files": [
    "biome-manifest.json",
    "configs"
  ],
  "exports": {
    "biome": "./biome-manifest.json"
  }
}
```

--------------------------------

### Initial Biome configuration

Source: https://next.biomejs.dev/guides/migrate-eslint-prettier

Initial Biome configuration that will be overwritten by the migration command.

```json
{
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  }
}
```

--------------------------------

### Biome CLI commands with npx

Source: https://next.biomejs.dev/guides/getting-started

Use the Biome CLI with npx to format, lint, and check code. The --write flag applies changes, and you can target specific files by replacing <files>.

```bash
# Format all files
npx @biomejs/biome format --write


# Format specific files
npx @biomejs/biome format --write <files>


# Lint files and apply safe fixes to all files
npx @biomejs/biome lint --write


# Lint files and apply safe fixes to specific files
npx @biomejs/biome lint --write <files>


# Format, lint, and organize imports of all files
npx @biomejs/biome check --write


# Format, lint, and organize imports of specific files
npx @biomejs/biome check --write <files>
```

--------------------------------

### Shared configuration with relative paths and extends

Source: https://next.biomejs.dev/guides/big-projects

Shows a shared common.json configuration and a biome.json that extends it. Relative paths in the shared file are resolved from the extending configuration's folder, not from the shared file's location.

```json
{
  "files": {
    "includes": ["src/**/*.js", "test/**/*.js"],
  },
  "linter": {
    "includes": ["**", "!test"]
  }
}
```

```json
{
  "extends": ["../common.json"]
}
```

--------------------------------

### Biome CLI commands with pnpx

Source: https://next.biomejs.dev/guides/getting-started

Use the Biome CLI with pnpx to format, lint, and check code. The --write flag applies changes, and you can target specific files by replacing <files>.

```bash
# Format all files
pnpx @biomejs/biome format --write


# Format specific files
pnpx @biomejs/biome format --write <files>


# Lint and apply safe fixes to all files
pnpx @biomejs/biome lint --write


# Lint files and apply safe fixes to specific files
pnpx @biomejs/biome lint --write <files>


# Format, lint, and organize imports of all files
pnpx @biomejs/biome check --write


# Format, lint, and organize imports of specific files
pnpx @biomejs/biome check --write <files>
```

--------------------------------

### Generate tracing log with Biome CLI

Source: https://next.biomejs.dev/guides/investigate-slowness

Run biome lint with tracing enabled to write a JSON log file containing timing information. Use --log-level=tracing, --log-kind=json, and --log-file=tracing.json.

```bash
biome lint --log-level=tracing --log-kind=json --log-file=tracing.json
```

--------------------------------

### Biome CLI commands with yarn

Source: https://next.biomejs.dev/guides/getting-started

Use the Biome CLI with yarn to format, lint, and check code. The --write flag applies changes, and you can target specific files by replacing <files>.

```bash
# Format all files
yarn exec biome format --write


# Format specific files
yarn exec biome format --write <files>


# Lint files and apply safe fixes to all files
yarn exec biome lint --write


# Lint files and apply safe fixes to specific files
yarn exec biome lint --write <files>


# Format, lint, and organize imports of all files
yarn exec biome check --write


# Format, lint, and organize imports of specific files
yarn exec biome check --write <files>
```

--------------------------------

### Extend a re-exported configuration

Source: https://next.biomejs.dev/guides/publish-packages

Shows how to extend a re-exported configuration (nuxt) from the package, using the package name in the extends array.

```json
{
  "extends": ["@org/biome-configs/configs/nuxt"]
}
```
Tokens:
Raw