@astral/biomejs-config

Совместимость с версией biomejs

!!! Совместим только с версией biomejs 2.x.x

Установка

npm install @biomejs/[email protected] @astral/biomejs-config --save-dev

Доступные конфиги

• @astral/biomejs-config/web - конфиг для frontend приложений
• @astral/biomejs-config/node - конфиг для nodejs приложений

Дополнительная функциональность конфигов

• Совместимость с @astral/eslint-config-react-ts
• Игнорирует файлы и директории, указанные в .gitignore
• Настроена и включена сортировка и группировка импортов
• Разрешает импорт пакета из devDeps в файлах конфигураций и тестах
• Разрешает использование console.log в файлах конфигураций

biome.web.json

• Разрешает использовать commonjs и console.log в файлах конфигураций
• Игнорирует .templates директорию
• Запрещает нарушение зависимостей архитектурных слоев (например, импорт из api из shared)
  • !!! Работает только для alias, начинающихся с # (#shared, #api). Правило style guide
• Запрещает прямое использование пакетов вне shared слоя:
  • Все пакеты с префиксом @astral
  • @mui/material
  • remeda
  • dayjs
  • react-hook-form
  • @tanstack/react-virtual

Настройка

Базовая настройка

Пример настройки.

Создать biome.json в корне

biome.json

{
  "$schema": "https://biomejs.dev/schemas/2.0.0/schema.json",
  "extends": ["@astral/biomejs-config/web"]
}

Включить автофикс при сохранении в IDE

Установить в IDE biome плагин.

VSCode

Настройка плагина.

{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.biome": "explicit",
    "source.organizeImports.biome": "explicit"
  }
}

WebStorm

После установки плагина перейти в Settings -> Languages & Frameworks -> Biome, включить все чекбоксы для форматирования при сохранении файла.

!!! Для корректной работы необходимо установить последнюю версию плагина >= 1.7.2, обратить внимание на совместимость с версией WebStorm

Версии плагина и совместимость с WS.

Monorepo

Пример настройки.

Ручная настройка запрета импортов между архитектурными слоями

Пример настройки.

Migration Guide: ESLint -> Biome

1. Заменить внутренние alias, с @ на # (пример: #shared, #api). Правило style guide

2. Удалить Eslint зависимости, отключить Eslint в IDE. Удалить Prettier, если не используется Stylelint.

3. Установить biome и @astral/biomejs-config

npm install @biomejs/[email protected] @astral/biomejs-config --save-dev

4. Добавить biome.json в корень проекта. Пример настройки в монорепозитории.

biome.json

{
  "$schema": "https://biomejs.dev/schemas/2.0.0/schema.json",
  "extends": ["@astral/biomejs-config/web"]
}

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

6. Заменить eslint-disable-next-line на соответствующий biome-ignore с указанием причины.

{
    eslint-disable-next-line -> biome-ignore
    
    @typescript-eslint/no-explicit-any -> lint/suspicious/noExplicitAny: Причина
    import/no-extraneous-dependencies -> lint/correctness/noUndeclaredDependencies: Причина
    @typescript-eslint/no-throw-literal -> lint/style/noParameterAssign: Причина
    @typescript-eslint/no-unused-vars -> lint/correctness/noUnusedVariables: Причина
    @typescript-eslint/no-shadow -> lint/suspicious/noShadowRestrictedNames: Причина
    no-param-reassign -> lint/style/noParameterAssign: Причина
    no-console -> lint/suspicious/noConsole: Причина
    @typescript-eslint/no-useless-constructor -> lint/complexity/noUselessConstructor: Причина
    @typescript-eslint/no-use-before-define -> lint/correctness/noInvalidUseBeforeDeclaration: Причина
}

Подробное сопоставление правил можно найти здесь https://biomejs.dev/linter/javascript/sources/#eslint

7. Заменить Eslint скрипты в package.json на biome

{
  "scripts": {
    "lint": "biome check --write --diagnostic-level=error",
    "lint:all": "biome check --write",
    "lint:ci": "biome check --diagnostic-level=error"
  }
}

8. Запустить скрипт lint:all. Он выполнит safe fix ошибок.

9. Выполнить unsafe фикс, если необходимо biome check --write --unsafe

10. Оставшиеся ошибки необходимо исправить руками. (Совет: если ошибок много - временно отключите соответствующие правила в локальном biome.json, затем включайте по одному для исправления)

11. Поменять скрипт в CI на "lint:ci"