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

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

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

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

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

Шаг 2: Склонировать и получить свою копию репозитория ESLint

Перейдите на https://github.com/eslint/eslint и нажмите кнопку «Склонировать». Следуйте документации GitHub по клонированию.

Склонируйте вашу вилку:

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

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

cd eslint
npm install

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

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

Шаг 3: Добавление исходного источника

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

Для добавления исходного источника ESLint выполните следующие действия в вашем репозитории:

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

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

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

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

npm install -g yo

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

npm install -g 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 для использования в браузере.