190 lines
11 KiB
Markdown
190 lines
11 KiB
Markdown
<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">
|
|
<img alt="Shows the banner of Biome, with its logo and the phrase 'Biome - Toolchain of the web'." src="https://raw.githubusercontent.com/biomejs/resources/main/svg/slogan-light-transparent.svg" width="700">
|
|
</picture>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
[![CI on main][ci-badge]][ci-url]
|
|
[![Discord chat][discord-badge]][discord-url]
|
|
[![npm version][npm-badge]][npm-url]
|
|
[![VSCode version][vscode-badge]][vscode-url]
|
|
[![Open VSX version][open-vsx-badge]][open-vsx-url]
|
|
|
|
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
|
|
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
|
|
[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=60a5fa
|
|
[discord-url]: https://biomejs.dev/chat
|
|
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=60a5fa&label=%40biomejs%2Fbiome
|
|
[npm-url]: https://www.npmjs.com/package/@biomejs/biome/v/latest
|
|
[vscode-badge]: https://img.shields.io/visual-studio-marketplace/v/biomejs.biome?label=Visual%20Studio%20Marketplace&labelColor=374151&color=60a5fa
|
|
[vscode-url]: https://marketplace.visualstudio.com/items?itemName=biomejs.biome
|
|
[open-vsx-badge]: https://img.shields.io/visual-studio-marketplace/v/biomejs.biome?label=Open%20VSX%20Registry&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyB2aWV3Qm94PSI0LjYgNSA5Ni4yIDEyMi43IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogIDxwYXRoIGQ9Ik0zMCA0NC4yTDUyLjYgNUg3LjN6TTQuNiA4OC41aDQ1LjNMMjcuMiA0OS40em01MSAwbDIyLjYgMzkuMiAyMi42LTM5LjJ6IiBmaWxsPSIjYzE2MGVmIi8+CiAgPHBhdGggZD0iTTUyLjYgNUwzMCA0NC4yaDQ1LjJ6TTI3LjIgNDkuNGwyMi43IDM5LjEgMjIuNi0zOS4xem01MSAwTDU1LjYgODguNWg0NS4yeiIgZmlsbD0iI2E2MGVlNSIvPgo8L3N2Zz4=&labelColor=374151&color=60a5fa
|
|
[open-vsx-url]: https://open-vsx.org/extension/biomejs/biome
|
|
|
|
<!-- 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 -->
|
|
|
|
[हिन्दी](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.hi.md) | English | [Español](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.es.md) | [Français](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.fr.md) | [繁體中文](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.zh-TW.md) | [简体中文](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.zh-CN.md) | [日本語](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.ja.md) | [Polski](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.pl.md) | [Português do Brasil](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.pt-BR.md) | [한국어](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.kr.md) | [Русский](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.ru.md) | [Українська](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.uk.md)
|
|
</div>
|
|
|
|
<br>
|
|
|
|
**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](./benchmark#formatting)** for _JavaScript_, _TypeScript_, _JSX_, _JSON_, _CSS_ and _GraphQL_ that scores **[97% compatibility with _Prettier_](https://console.algora.io/challenges/prettier)**.
|
|
|
|
**Biome is a [performant linter](https://github.com/biomejs/biome/tree/main/benchmark#linting)** for _JavaScript_, _TypeScript_, _JSX_, _JSON_, _CSS_, and _GraphQL_ that features **[more than 340 rules](https://biomejs.dev/linter/javascript/rules/)** from ESLint, typescript-eslint, and [other sources](https://github.com/biomejs/biome/discussions/3).
|
|
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](https://biomejs.dev/guides/editors/first-party-extensions/).
|
|
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](https://biomejs.dev/playground/), compiled to WebAssembly.
|
|
|
|
## Documentation
|
|
|
|
Check out our [homepage][biomejs] to learn more about Biome,
|
|
or directly head to the [Getting Started guide][getting-started] to start using Biome.
|
|
|
|
## More about Biome
|
|
|
|
**Biome** has sane defaults and it doesn't require configuration.
|
|
|
|
**Biome** aims to support [all main languages][language-support] of modern web development.
|
|
|
|
**Biome** [doesn't require Node.js](https://biomejs.dev/guides/manual-installation/) 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-philosophy].
|
|
|
|
**Biome** is [MIT licensed](https://github.com/biomejs/biome/tree/main/LICENSE-MIT) or [Apache 2.0 licensed](https://github.com/biomejs/biome/tree/main/LICENSE-APACHE) and moderated under the [Contributor Covenant Code of Conduct](https://github.com/biomejs/biome/tree/main/CODE_OF_CONDUCT.md).
|
|
|
|
## Funding
|
|
|
|
You can fund the project in different ways
|
|
|
|
### Project sponsorship and funding
|
|
|
|
You can sponsor or fund the project via [Open collective](https://opencollective.com/biome) or [GitHub sponsors](https://github.com/sponsors/biomejs)
|
|
|
|
Biome offers a simple sponsorship program that allows companies to get visibility and recognition among various developers.
|
|
|
|
Biome offers [enterprise support](https://biomejs.dev/enterprise), 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/depot-logo-horizontal-on-light@3x.png" />
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://depot.dev/assets/brand/1693758816/depot-logo-horizontal-on-dark@3x.png" />
|
|
<img src="https://depot.dev/assets/brand/1693758816/depot-logo-horizontal-on-light@3x.png" width="600" alt="Depot logo" />
|
|
</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"><img src="https://images.opencollective.com/l2beat/c2b2a27/logo/256.png" height="100" alt="L2BEAT logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://www.phoenixlabs.dev/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://images.opencollective.com/phoenix-labs/2824ed4/logo/100.png?height=100" height="100" alt="Phoenix Labs logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://lokalise.com/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/14294501?s=200&v=4" height="100" alt="Lokalise logo"></a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
### Bronze Sponsors
|
|
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="middle">
|
|
<a href="https://nanabit.dev/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://images.opencollective.com/nanabit/d15fd98/logo/256.png?height=80" width="80" alt="Nanabit logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://vital.io/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/25357309?s=200" width="80" alt="Vital logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://coderabbit.ai/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/132028505?s=200&v=4" width="80" alt="CodeRabbit logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://forge42.dev/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/161314831?s=200&v=4" width="80" alt="Forge42 logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="http://rstudio.org/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/513560?s=200&v=4" width="80" alt="RStudio logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://pennylane.com/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/57875210?s=200&v=4" width="80" alt="Pennylane logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://jetbrains.com/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.png" width="100" alt="JetBrains logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://www.egstock.co.jp/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://images.opencollective.com/egstock/b18c836/logo/256.png?height=256" width="80" alt="EGSTOCK, Inc. logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://www.convex.dev/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/81530787?s=200&v=4" width="80" alt="Convex logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://graphite.dev/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/61942612?s=200&v=4" width="80" alt="Graphite logo"></a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://kraken.tech/?utm_source=biome&utm_medium=readme" target="_blank"><img src="https://avatars.githubusercontent.com/u/105941848?s=200&v=4" width="80" alt="Kraken Tech logo"></a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
[biomejs]: https://biomejs.dev/
|
|
[biome-philosophy]: https://biomejs.dev/internals/philosophy/
|
|
[language-support]: https://biomejs.dev/internals/language-support/
|
|
[getting-started]: https://biomejs.dev/guides/getting-started/
|