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
Что это такое?Biome — это набор инструментов для веб-проектов: один быстрый инструмент, который и форматирует, и проверяет код (линтит) на JavaScript, TypeScript, JSX, JSON, CSS и GraphQL. Запускается из командной строки или из вашего редактора через LSP.
То есть это альтернатива Prettier и ESLint, которые раньше приходилось ставить вместе?По сути да. Он объединяет форматтер и линтер — инструменты, которые раньше были раздельными — на одной общей базе, поэтому вместо склеенного из отдельных частей набора вы получаете единый файл настроек, общий кэш и параллельное выполнение.
С чего начать работу с ним?Следуйте руководству Getting Started, чтобы добавить его в свой проект, или сначала попробуйте в онлайн-песочнице, которая скомпилирована в WebAssembly. Обязательная настройка не нужна: в Biome разумные настройки по умолчанию, и он работает без файла конфигурации.
Для его работы нужно, чтобы был установлен Node.js?Нет. Biome написан на Rust и для работы не требует Node.js — вы работаете с самостоятельным исполняемым файлом, среда выполнения JS не нужна.
А если в моём файле есть синтаксические ошибки — форматтер просто откажется работать?Он справляется со сломанным кодом, а не отвергает его: у парсера отличное восстановление после ошибок, поэтому Biome может форматировать и проверять файлы с некорректным кодом — даже пока вы их ещё печатаете в редакторе.
Это чисто консольная штука или может жить внутри моего редактора?И то и другое. Изначально он спроектирован для интерактивной работы в редакторе благодаря полноценной поддержке LSP, есть официальные расширения для VS Code и Open VSX, а консольный вариант закрывает задачи в скриптах и CI.
Насколько форматирование в Biome похоже на Prettier?Очень похоже: форматтер показывает 97% совместимости с Prettier, так что переход на Biome обычно не приводит к переформатированию всей вашей кодовой базы.
Откуда берутся его правила для проверки кода?В линтере больше 500 правил, взятых из ESLint, typescript-eslint и других источников, с подробными и понятными из контекста сообщениями об ошибках.
Зачем делать один инструмент, если можно взять Prettier плюс ESLint?Отдельные инструменты — это отдельные настройки, парсеры и запуски. Когда всё построено на общей базе, Biome даёт цельный опыт: обработку кода, показ ошибок, распараллеливание работы и кэширование.
Можно ли пользоваться бесплатно, в том числе компаниям?Да — проект распространяется по двойной лицензии MIT или Apache 2.0. Компании могут дополнительно спонсировать проект или купить корпоративную поддержку, когда ключевые участники проекта работают над задачами конкретной компании.
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