@biomejs/biome

हिन्दी | English | 繁體中文 | 简体中文 | 日本語 | 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, CSS and GraphQL that features more than 270 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 ./src

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

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

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

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 unifies functionality that has 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.

Issue funding

We use Polar.sh to up-vote and promote specific features that you would like to see and implement. Check our backlog and help us:

Sponsors

Gold Sponsors

Silver Sponsors

Bronze Sponsors

Changelog

v1.9.2 (2024-09-19)

CLI

New features

• Added support for custom GritQL definitions, including:

  • Pattern and predicate definitions: https://docs.grit.io/guides/patterns
  • Function definitions: https://docs.grit.io/language/functions#function-definitions

  Contributed by @arendjr

Bug fixes

• Fix #3917, where the fixed files were incorrectly computed. Contributed by @ematipico
• Fixed an issue that caused GritQL contains queries to report false positives when the matched node appeared inside a sibling node. Contributed by @arendjr

Editors

Bug fixes

• Fix #3923. Now the .editorconfig is correctly parsed by the LSP, and the options are correctly applied to files when formatting is triggered. Plus, the Biome LSP now watches for any change to the .editorconfig, and updates the formatting settings.

• Reduced the number of log files generated by the LSP server. Now the maximum number of logs saved on disk is seven. Contributed by @ematipico

• Fix the code actions capabilities available in the LSP Biome server. Before, the LSP was using the default capabilities, which resulted in pulling code actions even when they were disabled by the editor.

  This means that the code actions are pulled by the client only when the editor enables quickfix.biome, source.organizeImports.biome and source.fixAll.biome.

  Now, if you enable organizeImports.enabled: true in the biome.json, and then you configure your editor with the following code action source.organizeImports.biome: false, the editor won't sort the imports.

  Contributed by @ematipico

Linter

New features

• Add nursery/noMissingVarFunction. Contributed by @michellocana
• Add nursery/useComponentExportOnlyModules. Use this rule in React projects to enforce a code styling that fits React Refresh. Contributed by @GunseiKPaseri

Bug fixes

• noLabelWithoutControl now accept JSX expression as label value (#3875). Contributed by @Conaclos

• useFilenamingConvention no longer suggests names with a disallowed case (#3952). Contributed by @Conaclos

• useFilenamingConvention now recognizes file names starting with ASCII digits as lowercase (#3952).

  Thus, 2024-09-17-filename, 2024_09_17_filename and 20240917FileName are in kebab-case, snake_case, and camelCase respectively.

  Contributed by @Conaclos

• useFilenamingConvention now applies the configured formats to the file extensions (#3650). Contributed by @Conaclos

Parser

Bug fixes

• useStrictMode now reports Script files with some directives, but without the use strict directive. Contributed by @Conaclos

• The CSS parser now accepts the characters U+FFDCF and U+FFFD in identifiers. Contributed by @Conaclos