Быстрый старт

На этой странице — рекомендуемая настройка Oxlint и самые частые сценарии, с командами для копирования.

Установка

Установите oxlint как dev-зависимость:

npm

$ npm add -D oxlint

pnpm

$ pnpm add -D oxlint

yarn

$ yarn add -D oxlint

bun

$ bun add -D oxlint

Добавьте скрипты линтинга в package.json:

package.json

{
  "scripts": {
    "lint": "oxlint",
    "lint:fix": "oxlint --fix"
  }
}

Запуск:

npm

npm run lint

pnpm

pnpm run lint

yarn

yarn run lint

bun

bun run lint

Применение исправлений:

npm

npm run lint:fix

pnpm

pnpm run lint:fix

yarn

yarn run lint:fix

bun

bun run lint:fix

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

Полный список опций см. в справочнике CLI.

oxlint [OPTIONS] [PATH]...

Если PATH не указан, Oxlint проверяет текущий рабочий каталог.

Типичные сценарии

Pre-commit с lint-staged

npm

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "npm run lint"
  }
}

pnpm

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
  }
}

yarn

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "yarn run lint"
  }
}

bun

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "bun run lint"
  }
}

Создать файл конфигурации

Инициализируйте .oxlintrc.json значениями по умолчанию:

oxlint --init

Затем при необходимости отредактируйте .oxlintrc.json. См. Конфигурация.

Также поддерживается TypeScript-конфиг oxlint.config.ts. Подробности — в разделе Конфигурация.

Запуск Oxlint:

oxlint

TIP

При миграции с ESLint см. страницу «Миграция с ESLint».

Исправление проблем

Безопасные исправления:

oxlint --fix

Предложения (могут менять поведение программы):

oxlint --fix-suggestions

Опасные исправления и предложения:

oxlint --fix-dangerously

Когда что использовать — в разделе Автоматические исправления.

Игнорирование файлов

Явный файл игноров:

oxlint --ignore-path .oxlintignore

Шаблоны из командной строки:

oxlint --ignore-pattern "dist/**" --ignore-pattern "*.min.js"

Отключить обработку игноров:

oxlint --no-ignore

См. Игнорирование файлов.

Стабильный CI

Только ошибки:

oxlint --quiet

Завершаться с ошибкой при любых предупреждениях:

oxlint --deny-warnings

Ошибка при превышении числа предупреждений:

oxlint --max-warnings 0

См. Настройка CI.

Машиночитаемый вывод

Формат вывода:

oxlint -f json

Доступны: default, json, unix, checkstyle, github, gitlab, junit и stylish. Подробнее — Форматы вывода.

Просмотр эффективной конфигурации

Вывести конфиг, который будет применён к файлу:

oxlint --print-config path/to/file.ts

Список правил

Зарегистрированные правила с учётом текущего конфига:

oxlint --rules

Полный перечень — в справочнике правил.

Дальше

• Правила, плагины и игноры: Конфигурация
• Редакторы
• CI
• Дополнительно: Многофайловый анализ, Линтинг с типами, JS-плагины
• Миграция: с ESLint
• Матрица совместимости
• Справочник CLI