biome README

The project's README from github.com/biomejs/biome. As one markdown file: README.md.

Shows the banner of Biome, with its logo and the phrase 'Biome - Toolchain of the web'.

CI on main Discord chat npm version VSCode version Open VSX version

हिन्दी | English | Español | Français | 繁體中文 | 简体中文 | 日本語 | Polski | Português do Brasil | 한국어 | Русский | Українська


Biome is a performant toolchain for web projects, it aims to provide developer tools to maintain the health of said projects.

Biome is a fast formatter for JavaScript, TypeScript, JSX, JSON, CSS and GraphQL that scores 97% compatibility with Prettier.

Biome is a performant linter for JavaScript, TypeScript, JSX, JSON, CSS, and GraphQL that features more than 500 rules from ESLint, typescript-eslint, and other sources. It outputs detailed and contextualized diagnostics that help you to improve your code and become a better programmer!

Biome is designed from the start to be used interactively within an editor. It can format and lint malformed code as you are writing it.

Installation

npm install --save-dev --save-exact @biomejs/biome

Usage

# format files
npx @biomejs/biome format --write

# lint files and apply the safe fixes
npx @biomejs/biome lint --write

# run format, lint, etc. and apply the safe fixes
npx @biomejs/biome check --write

# check all files against format, lint, etc. in CI environments
npx @biomejs/biome ci

If you want to give Biome a run without installing it, use the online playground, compiled to WebAssembly.

Documentation

Check out our homepage to learn more about Biome, or directly head to the Getting Started guide to start using Biome.

More about Biome

Biome has sane defaults and it doesn't require configuration.

Biome aims to support all main languages of modern web development.

Biome doesn't require Node.js to function.

Biome has first-class LSP support, with a sophisticated parser that represents the source text in full fidelity and top-notch error recovery.

Biome wants to offer a high-quality Developer Experience, with descriptive diagnostics and great performance.

Biome unifies functionalities that have previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelize work, caching, and configuration.

Read more about our project philosophy.

Biome is MIT licensed or Apache 2.0 licensed and moderated under the Contributor Covenant Code of Conduct.

Funding

You can fund the project in different ways

Project sponsorship and funding

You can sponsor or fund the project via Open collective or GitHub sponsors

Biome offers a simple sponsorship program that allows companies to get visibility and recognition among various developers.

Biome offers enterprise support, where Core Contributors can be employed to work on company-focused projects.

Sponsors

Platinum Sponsors

Depot logo

Gold Sponsors

CodSpeed logo

Silver Sponsors

Lokalise logo Latitude logo Cloudflare logo

Bronze Sponsors

Vital logo CodeRabbit logo Forge42 logo RStudio logo Pennylane logo JetBrains logo EGSTOCK, Inc. logo Convex logo Graphite logo Kraken Tech logo

biome (biomejs/biome)

Searching Database…

26K ·GitHub
What is this?Biome is a toolchain for web projects: one fast tool that both formats and lints JavaScript, TypeScript, JSX, JSON, CSS and GraphQL, run from the CLI or your editor via LSP.
So is it an alternative to running Prettier and ESLint side by side?Essentially yes. It unifies the formatter and the linter — tools that used to be separate — on one shared base, so you get a single config, shared caching and parallel runs instead of a stitched-together toolchain.
How do I get started with it?Follow the Getting Started guide to add it to your project, or try it first in the online playground, which is compiled to WebAssembly. There is no mandatory configuration step: Biome has sane defaults and works without a config file.
Do I need Node.js installed for it to work?No. Biome is written in Rust and does not require Node.js to function — you work with a standalone binary, no JS runtime needed.
What if my file has syntax errors — does the formatter just refuse to run?It handles broken code rather than refusing it: the parser has top-notch error recovery, so Biome can format and lint malformed files, even while you are still typing them in the editor.
Is it a command-line thing, or can it live inside my editor?Both. It is designed from the start to be used interactively within an editor via first-class LSP support, with official VS Code and Open VSX extensions, while the CLI covers scripts and CI.
How close is Biome's formatting to Prettier's?Very close: the formatter scores 97% compatibility with Prettier, so adopting Biome usually does not reformat your whole codebase.
Where do its lint rules come from?The linter features more than 500 rules drawn from ESLint, typescript-eslint and other sources, with detailed and contextualized diagnostics.
Why build one tool instead of using Prettier plus ESLint?Separate tools mean separate configs, parsers and runs. Building everything on a shared base lets Biome provide a cohesive experience for processing code, displaying errors, parallelizing work and caching.
Is it free to use, even for companies?Yes — it is dual-licensed under MIT or Apache 2.0. Companies can additionally sponsor the project or buy enterprise support, where core contributors work on company-focused projects.
What are similar projects?oxc, tools, prettier, rubocop, eslint, ruff, knip, fallow
Creator
biomejs
Size
285.9 MB
Stars
26K
Age
3y
Commits · 90 Days