Линт проектов: собираем ESLint, Prettier и Stylelint в один пакет

В сфере искусственного интеллекта произошло заметное событие. Dozalex 58 минут назад Линт проектов: собираем ESLint, Prettier и Stylelint в один пакет Средний 11 мин 1. 7K JavaScript * Веб-разработка * ReactJS * TypeScript * Туториал ВведениеВ большинстве компаний линтинг со временем превращается в хаос: разные правила ESLint, устаревшие конфиги и копипаста между проектами. Покажу, как навести порядок – собрать линт-инфраструктуру в один пакет и выстроить систему контроля кода для всех репозиториев.

Для кого эта статьяСтатья будет полезна:разработчикам, которые хотят навести порядок в линтинге нескольких проектов;тимлидам и техлидам, которые строят единые стандарты кода в команде;тем, кто планирует вынести конфигурации ESLint, Prettier и Stylelint в отдельный пакет. Предполагается базовое знакомство с ESLint, Prettier и экосистемой JavaScript. Почему для компании стоит создавать свой lint пакетЕсли в компании больше одного проекта, со временем почти всегда появляется одинаковая проблема: линт-конфиги начинают расползаться.

Технические детали

В одном репозитории ESLint настроен так, в другом – немного иначе. Где-то есть stylelint, где-то нет. В одном проекте используются recommended правила, в другом – половина из них отключена.

Через год это обычно выглядит примерно так:одинаковые конфиги копируются из проекта в проект;правила случайно расходятся;при обновлении ESLint или плагинов каждый репозиторий приходится чинить отдельно;новые проекты начинают, используя старые, устаревшие конфиги. В итоге линтинг, который должен помогать поддерживать единый стиль кода, сам становится источником хаоса. Решение у этой проблемы довольно простое – вынести всю линт-инфраструктуру в отдельный npm-пакет: @company/lint.

После этого:все проекты используют одни и те же правила;обновление линта происходит в одном месте;новые проекты получают готовую инфраструктуру за минуту;команда может обновлять правила постепенно. По сути, компания начинает относиться к линтингу как к части своей инженерной платформы, а не как к случайному набору файлов конфигов. Содержимое lint пакетаLint-пакет стоит рассматривать не просто как сборку конфигураций, а как централизованный гайдлайн по стандартам кода компании.

Отраслевые последствия

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

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

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