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

ESLint — это инструмент для выявления и отчётности о шаблонах в коде ECMAScript/JavaScript, цель которого — сделать код более согласованным и избежать ошибок.

ESLint полностью подключаемый. Каждое правило — это плагин, и вы можете добавлять больше во время выполнения. Вы также можете добавлять плагины сообщества, конфигурации и парсеры для расширения функциональности ESLint.

Предварительные требования

Для использования ESLint необходимо установить Node.js (^18.18.0, ^20.9.0, или >=21.1.0) с поддержкой SSL. (Если вы используете официальное дистрибутивное Node.js, SSL всегда включён.)

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

Вы можете установить и настроить ESLint с помощью этой команды:

npm init @eslint/config@latest

# or

yarn create @eslint/config

# or

pnpm create @eslint/config@latest

Если вы хотите использовать определённую общую конфигурацию, размещённую на npm, вы можете использовать опцию --config и указать имя пакета:

# use `eslint-config-standard` shared config

# npm 7+
npm init @eslint/config@latest -- --config eslint-config-standard

Примечание: npm init @eslint/config предполагает, что у вас уже есть файл package.json. Если нет, убедитесь, что выполнили npm init или yarn init предварительно.

После этого вы можете запустить ESLint для любого файла или каталога следующим образом:

npx eslint yourfile.js

# or

yarn run eslint yourfile.js

Конфигурация

Примечание: Если вы перешли с версии до 9.0.0, ознакомьтесь с руководством по миграции.

После выполнения npm init @eslint/config, в вашем каталоге появится файл eslint.config.js (или eslint.config.mjs). В нём вы увидите настроенные правила, например:

// eslint.config.js
export default [
    {
        rules: {
            "no-unused-vars": "error",
            "no-undef": "error"
        }
    }
];

Имена "no-unused-vars" и "no-undef" — это имена правил в ESLint. Первое значение — уровень ошибки правила, и оно может быть одним из этих значений:

• "off" или 0 — отключить правило
• "warn" или 1 — включить правило как предупреждение (не влияет на код выхода)
• "error" или 2 — включить правило как ошибку (код выхода будет 1)

Три уровня ошибок позволяют вам тонко управлять тем, как ESLint применяет правила (для получения дополнительных параметров конфигурации и деталей см. документацию по конфигурации).

Ваш файл конфигурации eslint.config.js также будет содержать рекомендуемую конфигурацию, например:

// eslint.config.js
import js from "@eslint/js";

export default [
    js.configs.recommended,

    {
        rules: {
            "no-unused-vars": "warn",
            "no-undef": "warn"
        }
    }
];

Объект js.configs.recommended содержит конфигурацию, чтобы убедиться, что все правила, помеченные как рекомендуемые на странице правил, будут включены. В качестве альтернативы вы можете использовать конфигурации, созданные другими пользователями, выполнив поиск «eslint-config» на npmjs.com. ESLint не будет проверять ваш код, если вы не используете общую конфигурацию или не включите правила в свою конфигурацию явно.

Глобальная установка

Также можно установить ESLint глобально, а не локально, используя npm install eslint --global. Однако это не рекомендуется, и любые плагины или общие конфигурации, которые вы используете, всё равно должны быть установлены локально, если вы устанавливаете ESLint глобально.

Настройка вручную

Вы также можете настроить ESLint в своём проекте вручную.

Прежде чем начать, у вас должен быть файл package.json. Если нет, убедитесь, что выполнили npm init или yarn init для его создания предварительно.

1. Установите пакеты ESLint в своём проекте:

   npm install --save-dev eslint @eslint/js
   

2. Добавьте файл eslint.config.js:

   # Create JavaScript configuration file
   touch eslint.config.js
   

3. Добавьте конфигурацию в файл eslint.config.js. Обратитесь к документации по настройке ESLint, чтобы узнать, как добавить правила, пользовательские конфигурации, плагины и другое.

   import js from "@eslint/js";
   
   export default [
       js.configs.recommended,
   
      {
          rules: {
              "no-unused-vars": "warn",
              "no-undef": "warn"
          }
      }
   ];
   

4. Проверьте код с помощью ESLint CLI:

   npx eslint project-dir/ file1.js
   

   Дополнительную информацию об доступных опциях CLI можно найти на странице Командная строка.

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

• Узнайте об расширенной настройке ESLint.
• Ознакомьтесь с опциями командной строки.
• Изучите интеграции ESLint в другие инструменты, такие как редакторы, системы сборки и многое другое.
• Не можете найти подходящее правило? Создайте своё собственное настраиваемое правило.
• Улучшите ESLint, сотрудничая над ним.