Начало работы

Biome лучше всего устанавливать в качестве dev-зависимости ваших проектов, но он также доступен в виде автономного исполняемого файла, которому не требуется Node.js.

1
npm i -D -E @biomejs/biome

1
pnpm add -D -E @biomejs/biome

1
bun add -D -E @biomejs/biome

1
deno add -D npm:@biomejs/biome

1
yarn add -D -E @biomejs/biome

Настройка

Несмотря на то, что Biome не требует настройки, вы, вероятно, захотите подстроить параметры под нужды вашего проекта. Для этого вы можете выполнить следующую команду для создание файла настроек biome.json.

1
npx @biomejs/biome init

1
pnpm exec biome init

1
bunx --bun biome init

1
deno run -A npm:@biomejs/biome init

1
yarn exec biome init

Использование

Давайте вкратце рассмотрим, как использовать Biome в вашем проекте.

Интерфейс командной строки (CLI)

Biome предоставляет интерфейс командной строки для форматирования, линтинга и проверки вашего кода.

1
# Отформатировать все файлы
2
npx @biomejs/biome format --write
3

4
# Отформатировать выбранные файлы
5
npx @biomejs/biome format --write <файлы>
6

7
# Выполнить линтинг и применить безопасные исправления для всех файлов
8
npx @biomejs/biome lint --write
9

10
# Выполнить линтинг и применить безопасные исправления для выбранных файлов
11
npx @biomejs/biome lint --write <файлы>
12

13
# Отформатировать, выполнить линтинг и организовать импорты всех файлов
14
npx @biomejs/biome check --write
15

16
# Отформатировать, выполнить линтинг и организовать импорты выбранных файлов
17
npx @biomejs/biome check --write <файлы>

1
# Отформатировать все файлы
2
pnpm exec biome format --write
3

4
# Отформатировать выбранные файлы
5
pnpm exec biome format --write <файлы>
6

7
# Выполнить линтинг и применить безопасные исправления для всех файлов
8
pnpm exec biome lint --write
9

10
# Выполнить линтинг и применить безопасные исправления для выбранных файлов
11
pnpm exec biome lint --write <файлы>
12

13
# Отформатировать, выполнить линтинг и организовать импорты всех файлов
14
pnpm exec biome check --write
15

16
# Отформатировать, выполнить линтинг и организовать импорты выбранных файлов
17
pnpm exec biome check --write <файлы>

1
# Отформатировать все файлы
2
bunx biome format --write
3

4
# Отформатировать выбранные файлы
5
bunx biome format --write <файлы>
6

7
# Выполнить линтинг и применить безопасные исправления для всех файлов
8
bunx biome lint --write
9

10
# Выполнить линтинг и применить безопасные исправления для выбранных файлов
11
bunx biome lint --write <файлы>
12

13
# Отформатировать, выполнить линтинг и организовать импорты всех файлов
14
bunx biome check --write
15

16
# Отформатировать, выполнить линтинг и организовать импорты выбранных файлов
17
bunx biome check --write <файлы>

1
# Отформатировать выбранные файлы
2
deno run -A npm:@biomejs/biome format --write <файлы>
3

4
# Отформатировать все файлы
5
deno run -A npm:@biomejs/biome format --write
6

7
# Выполнить линтинг и применить безопасные исправления для всех файлов
8
deno run -A npm:@biomejs/biome lint --write
9

10
# Выполнить линтинг и применить безопасные исправления для выбранных файлов
11
deno run -A npm:@biomejs/biome lint --write <файлы>
12

13
# Отформатировать, выполнить линтинг и организовать импорты всех файлов
14
deno run -A npm:@biomejs/biome check --write
15

16
# Отформатировать, выполнить линтинг и организовать импорты выбранных файлов
17
deno run -A npm:@biomejs/biome check --write <файлы>

1
# Отформатировать все файлы
2
yarn exec biome format --write
3

4
# Отформатировать выбранные файлы
5
yarn exec biome format --write <файлы>
6

7
# Выполнить линтинг и применить безопасные исправления для всех файлов
8
yarn exec biome lint --write
9

10
# Выполнить линтинг и применить безопасные исправления для выбранных файлов
11
yarn exec biome lint --write <файлы>
12

13
# Отформатировать, выполнить линтинг и организовать импорты всех файлов
14
yarn exec biome check --write
15

16
# Отформатировать, выполнить линтинг и организовать импорты выбранных файлов
17
yarn exec biome check --write <файлы>

Интеграция с редакторами

Biome доступен в качестве официального дополнения в ваших любимых редакторах.

Также существуют дополнения от сообщества для других редакторов, таких как Vim, Neovim и Sublime Text, например.

Непрерывная интеграция

Выполните biome ci в качестве части CI-пайплайна, чтобы увеличить качество и согласованность кода вашей команды. Это работает также, как и команда biome check, но оптимизировано под окружения CI.

Посетите рецепты Непрерывной интеграции, чтобы получить больше примеров.

Дальнейшие шаги

Готово! Теперь вы готовы к использованию Biome. 🥳

Мигрировать с ESLint и Prettier
Узнать больше о том, как настроить Biome
Узнать больше о том, как использовать и настраивать форматтер
Узнать больше о том, как использовать и настраивать линтер
Ознакомиться с командами и параметрами CLI
Ознакомиться с параметрами настройки
Присоединиться к нашему сообществу в Discord