Back to Biome

README

README.md

latest10.8 KB
Original Source
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/biomejs/resources/main/svg/slogan-dark-transparent.svg"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/biomejs/resources/main/svg/slogan-light-transparent.svg"> </picture>

<!-- Insert new entries lexicographically by language code. For example given below is the same order as these files appear on page: https://github.com/biomejs/biome/tree/main/packages/@biomejs/biome -->

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

</div>

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 450 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

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

Usage

shell
# 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

<table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://depot.dev/?utm_source=biome&utm_medium=readme" target="_blank"> <picture> <source media="(prefers-color-scheme: light)" srcset="https://depot.dev/assets/brand/1693758816/[email protected]" /> <source media="(prefers-color-scheme: dark)" srcset="https://depot.dev/assets/brand/1693758816/[email protected]" />
      </picture>
    </a>
  </td>
</tr>
</tbody> </table>

Silver Sponsors

<table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://l2beat.com/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://lokalise.com/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> </tr> </tbody> </table>

Bronze Sponsors

<table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://vital.io/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://coderabbit.ai/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://forge42.dev/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="http://rstudio.org/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://pennylane.com/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://jetbrains.com/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://www.egstock.co.jp/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://www.convex.dev/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://graphite.dev/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> <td align="center" valign="middle"> <a href="https://kraken.tech/?utm_source=biome&utm_medium=readme" target="_blank"></a> </td> </tr> </tbody> </table>