Настройка среды разработки

Среда разработки ESLint очень лёгкая, поэтому обновлять код быстро и просто. Это пошаговое руководство по настройке локальной среды разработки, которая позволит вам вносить свой вклад в проект.

Шаг 1: Установите Node.js

Перейдите на сайт https://nodejs.org/, чтобы скачать и установить последнюю стабильную версию для вашей операционной системы.

Большинство установщиков уже включают npm, но если по какой-либо причине npm не работает в вашей системе, его можно установить вручную, следуя инструкциям на сайте.

Шаг 2: Создайте форк и клонируйте собственный репозиторий ESLint

Перейдите на страницу https://github.com/eslint/eslint и нажмите кнопку «Fork». Следуйте документации GitHub, чтобы создать форк и клонировать репозиторий.

Клонируйте свой форк:

git clone https://github.com/<Your GitHub Username>/eslint

После клонирования репозитория выполните npm install, чтобы установить все необходимые зависимости:

cd eslint

npm install

yarn add

pnpm add

bun add

Для выполнения этого шага необходимо подключение к Интернету. Вы увидите, как загружается множество утилит.

Примечание: Рекомендуется повторно выполнять npm install после каждого получения изменений из основного репозитория, чтобы у вас всегда были последние зависимости для разработки.

Шаг 3: Добавьте исходный репозиторий

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

Чтобы добавить исходный репозиторий ESLint, выполните в своём репозитории следующую команду:

git remote add upstream git@github.com:eslint/eslint.git

Теперь удалённый репозиторий upstream указывает на исходный репозиторий.

Шаг 4: Установите генератор Yeoman

Yeoman — это генератор шаблонов, который ESLint использует для упрощения разработки новых правил. Если Yeoman ещё не установлен, его можно установить с помощью npm:

npm install --global yo

yarn global add yo

pnpm add --global yo

bun add --global yo

Затем можно установить генератор ESLint для Yeoman:

npm install --global generator-eslint

yarn global add generator-eslint

pnpm add --global generator-eslint

bun add --global generator-eslint

Инструкции по использованию см. в документации генератора.

Шаг 5: Запустите тесты

Запуск тестов — лучший способ убедиться, что среда разработки настроена правильно. Убедитесь, что вы находитесь в каталоге eslint, и выполните:

npm test

Выполнение тестов занимает несколько минут. Если какие-либо тесты завершатся с ошибкой, вероятно, один или несколько этапов настройки среды выполнены неправильно. Тесты в основном репозитории всегда проходят успешно.

Справочная информация

Структура каталогов

Каталоги и файлы ESLint имеют следующую структуру:

• bin — исполняемые файлы, доступные после установки ESLint.
• conf — сведения о конфигурации по умолчанию.
• docs — документация проекта.
• lib — содержит исходный код.
  • formatters — все исходные файлы, определяющие форматтеры.
  • rules — все исходные файлы, определяющие правила.
• tests — основной каталог модульных тестов.
  • lib — тесты исходного кода.
    • formatters — тесты форматтеров.
    • rules — тесты правил.

Рабочий процесс

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

Сценарии сборки

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

npm test

Основной сценарий для запуска — npm test. Он выполняет несколько действий:

1. Проверяет качество всего кода JavaScript (включая тесты) и JSON.
2. Запускает все тесты в Node.js.
3. Проверяет целевые показатели покрытия кода.
4. Создаёт build/eslint.js для использования в браузере.
5. Запускает часть тестов в PhantomJS.

Обязательно запускайте этот сценарий после внесения изменений и перед отправкой запроса на слияние с вашими изменениями.

Примечание: Полный отчёт о покрытии кода сохраняется в /coverage.

npm run lint

Выполняет только проверку качества кода JavaScript и JSON в репозитории.

npm run webpack

Создаёт build/eslint.js — версию ESLint для использования в браузере.