Registry / devops / vite-plugin-biome

vite-plugin-biome

library1.2.0jsnpmunverified

vite-plugin-biome (v1.2.0) integrates Biome linting, formatting, and checking into the Vite dev server loop. It runs on startup and on hot module replacements, providing immediate feedback during development without separate CLI steps. Supports Biome >=1.8.0 and Vite >=4.x. Key differentiators: automatic fix application, configurable hot update modes (full or changed-only), build-fail-on-error, and extra Biome CLI argument passthrough. Ships TypeScript types.

devops

npm install vite-plugin-biome

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-BIOME

vite-plugin-biome

devopsjavascriptv1.2.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import biomePlugin from 'vite-plugin-biome'

✗ const biomePlugin = require('vite-plugin-biome')

ESM-only package; CommonJS require() fails. Use dynamic import() if needed in CJS context.

default

✓ import biomePlugin from 'vite-plugin-biome'

✗ import { biomePlugin } from 'vite-plugin-biome'

The package exports a single default function, not a named export.

type Options

✓ import type { Options } from 'vite-plugin-biome'

✗ import { Options } from 'vite-plugin-biome'

Options interface is exported as a type; use `import type` in TypeScript to avoid runtime errors.

default (require)

✓ const biomePlugin = (await import('vite-plugin-biome')).default

✗ const biomePlugin = require('vite-plugin-biome')

In CJS, use dynamic import() and take .default. Direct require() throws ERR_REQUIRE_ESM.

Minimal Vite config enabling Biome check with auto-fix on all source files during dev.

// vite.config.ts import { defineConfig } from 'vite'; import biomePlugin from 'vite-plugin-biome'; export default defineConfig({ plugins: [ biomePlugin({ mode: 'check', files: 'src/**/*.{js,ts,jsx,tsx}', applyFixes: true, failOnError: false, }), ], }); // Then install peer deps: // npm install -D vite-plugin-biome @biomejs/biome

Debug

Known issues

gotchaDefault import is the only export; named import like `import { biomePlugin }` will import `undefined`.

fix

Use `import biomePlugin from 'vite-plugin-biome'`.

affects: >=0.0.0

breakingPlugin is ESM-only; using `require('vite-plugin-biome')` throws ERR_REQUIRE_ESM.

fix

Use dynamic `import()` or switch to ESM in your project (e.g., type: 'module' in package.json).

affects: >=1.0.0

breakingPeer dependency @biomejs/biome must be >=1.8.0; older Biome versions cause runtime errors or missing commands.

fix

Install @biomejs/biome@^1.8.0 as a devDependency.

affects: >=0.0.0

gotchaSetting `failOnError: true` may cause unexpected build failures during development if Biome reports warnings or formatting issues.

fix

Use `failOnError: true` only for production builds (e.g., VITE_BUILD_MODE env check) to avoid blocking dev server.

affects: >=0.0.0

gotcha`hotUpdateMode: 'changed'` still runs a full startup scan; only HMR triggers are scoped to changed files. Expect full scan on dev start.

fix

Accept startup behavior; if you need to avoid startup scan, configure `files` selectively (e.g., `files: 'src'`).

affects: >=0.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/node_modules/vite-plugin-biome/dist/index.mjs not supported.

Using CommonJS require() on an ESM-only package.

fix

Use `import biomePlugin from 'vite-plugin-biome'` (ESM) or dynamic `import()` in CJS: `const biomePlugin = (await import('vite-plugin-biome')).default;`

TypeError: biomePlugin is not a function

Imported named export `{ biomePlugin }` instead of default.

fix

Use `import biomePlugin from 'vite-plugin-biome'` (default import).

Error: Could not resolve '@biomejs/biome' (peer dependency)

Missing required peer dependency @biomejs/biome.

fix

Run `npm install -D @biomejs/biome` or `yarn add -D @biomejs/biome`.

Error: Biome command 'format' failed: exit code 1

Biome encountered a formatting error or misconfiguration in biome.json.

fix

Check Biome config (e.g., `biome.json`) for invalid rules or file exclusions. Run `npx biome format --write .` to test standalone.

Error: Unknown argument: --changed

Using --changed flag with Biome <1.9.0 which does not support it.

fix

Upgrade @biomejs/biome to >=1.9.0 or remove `--changed` from `biomeAdditionalArgs`.

Upgrade

Version history

1.2.0latest on npm

Audit

Dependencies

@biomejs/biomerequiredPeer dependency: Biome binary used for linting/formatting/checking.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/skrulling/vite-plugin-biome ↗

packagehttps://www.npmjs.com/package/vite-plugin-biome ↗