Основные понятия

На этой странице представлен общий обзор некоторых основных понятий ESLint.

Что такое ESLint?

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

Правила

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

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

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

Дополнительные сведения см. в разделе «Правила».

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

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

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

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

Предложения правил

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

1. Предложения могут изменять логику приложения, поэтому их нельзя применять автоматически.
2. Предложения нельзя применять через CLI 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 перед его разбором в ESLint.

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

Форматтеры

Форматтер ESLint определяет, как отображаются результаты проверки в CLI.

Дополнительные сведения см. в разделе «Форматтеры».

Интеграции

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

Дополнительные сведения см. в разделе «Интеграции».

CLI и API Node.js

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

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

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

Дополнительные сведения см. в разделах «Интерфейс командной строки» и «API Node.js».