1. Project Overview & Quickstart (biomejs/biome)
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/biomeUsage
# 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 ciIf 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
Gold Sponsors
Silver Sponsors
Bronze Sponsors
2. Official Technical Reference & Guides (biomejs/website)
[`biomejs.dev`](https://biomejs.dev/)
The website source of biomejs/biome.
Clone
To clone the repository, run
git clone https://github.com/biomejs/websiteInstallation
First install pnpm by enabling corepack:
corepack enableThen install the required dependencies:
pnpm i --frozen-lockfileLocal Development
This command starts a local development server:
pnpm devMost changes are reflected live without having to restart the server.
Code generation
The pages of the lint rules are all code generated from the repository biomejs/biome. To update the pages you have to install the Rust toolchain, because
the code that does that requires reading the source code of the analyzer.
First, make sure that you've pulled the latest version of the repository and installed the required toolchains, then run the corresponding scripts from the repo root via pnpm:
# generate only rules files
pnpm codegen:rules
# generate only rules metadata
pnpm codegen:metadata
# generate only release files
pnpm codegen:release-files
# generate all files
pnpm codegen:allBuild
This command generates static content into the dist directory:
pnpm buildThe dist directory can be served using any static contents hosting service, or you can preview the site locally with
pnpm preview