Основные концепции

Эта страница содержит общее описание некоторых основных концепций ESLint.

Что такое ESLint?

ESLint — это настраиваемый линтер JavaScript. Он помогает вам находить и исправлять проблемы в вашем коде JavaScript. Проблемы могут быть чем угодно, от потенциальных ошибок во время выполнения до нарушения лучших практик и проблем с форматированием.

Правила

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

Например, правило semi позволяет указать, должны ли операторы JavaScript заканчиваться точкой с запятой (;). Вы можете настроить правило так, чтобы оно всегда требовало точек с запятой или требовало, чтобы оператор никогда не заканчивался точкой с запятой.

ESLint содержит сотни встроенных правил, которые вы можете использовать. Вы также можете создавать пользовательские правила или использовать правила, созданные другими, с помощью плагинов.

Для получения дополнительной информации, обратитесь к Правилам.

Исправления правил

Правила могут необязательно предоставлять исправления для нарушений, которые они обнаруживают. Исправления безопасно исправляют нарушение, не изменяя логику приложения.

Исправления могут применяться автоматически с помощью опции командной строки --fix и через расширения редакторов.

Правила, которые могут предоставлять исправления, помечены значком 🔧 в Правилах.

Рекомендации правил

Правила могут необязательно предоставлять рекомендации помимо или вместо исправлений. Рекомендации отличаются от исправлений двумя способами:

1. Рекомендации могут изменять логику приложения, поэтому их нельзя автоматически применять.
2. Рекомендации нельзя применять через командную строку ESLint, и они доступны только через интеграции с редакторами.

Правила, которые могут предоставлять рекомендации, помечены значком 💡 в Правилах.

Файлы конфигурации

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

Для получения дополнительной информации, обратитесь к Файлам конфигурации.

Общие конфигурации

Общие конфигурации — это конфигурации ESLint, которые распространяются через npm.

Общие конфигурации часто используются для соблюдения руководств по стилю с помощью встроенных правил ESLint. Например, общая конфигурация eslint-config-airbnb-base реализует популярное руководство по стилю JavaScript от Airbnb.

Для получения дополнительной информации, обратитесь к Использованию пакета с общей конфигурацией.

Плагины

Плагин ESLint — это модуль npm, который может содержать набор правил ESLint, конфигураций, процессоров и сред. Часто плагины включают пользовательские правила. Плагины могут использоваться для соблюдения руководств по стилю и поддержки расширений JavaScript (например, TypeScript), библиотек (например, React) и фреймворков (Angular).

Популярный случай использования плагинов — обеспечение соблюдения лучших практик для фреймворка. Например, @angular-eslint/eslint-plugin содержит лучшие практики для использования фреймворка Angular.

Для получения дополнительной информации, обратитесь к Конфигурации плагинов.

Парсеры

Парсер ESLint преобразует код в дерево абстрактного синтаксиса, которое ESLint может оценить. По умолчанию ESLint использует встроенный парсер Espree, который совместим со стандартными средами и версиями JavaScript.

Пользовательские парсеры позволяют ESLint парсить нестандартный синтаксис JavaScript. Зачастую пользовательские парсеры включаются в состав общих конфигураций или плагинов, поэтому вам не нужно использовать их напрямую.

Например, @typescript-eslint/parser — это пользовательский парсер, включённый в проект typescript-eslint, который позволяет ESLint парсить код TypeScript.

Пользовательские процессоры

Процессор ESLint извлекает код JavaScript из других типов файлов, а затем позволяет ESLint проверить код JavaScript. Кроме того, вы можете использовать процессор для изменения кода JavaScript перед его парсингом с помощью ESLint.

Например, @eslint/markdown содержит пользовательский процессор, который позволяет проверять код JavaScript внутри блоков кода Markdown.

Форматировщики

Форматировщик ESLint контролирует внешний вид результатов проверки в командной строке.

Для получения дополнительной информации, обратитесь к Форматировщикам.

Интеграции

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

Для получения дополнительной информации, обратитесь к Интеграциям.

CLI и API Node.js

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

API ESLint Node.js позволяет использовать ESLint программно из кода Node.js. API полезно при разработке плагинов, интеграций и других инструментов, связанных с ESLint.

Если вы не расширяете ESLint каким-либо образом, используйте командную строку.

Для получения дополнительной информации, обратитесь к Командной строке и API Node.js.