eslint-config-rtkit

Набор конфигов eslint для проектов Ростелеком ИТ.

Включает в себя варианты использования на проектах с JavaScript, TypeScript в связке с React или без.

Требования

node >= 16

Установка

yarn add eslint-config-rtkit -D

или

npm install eslint-config-rtkit --save-dev

Важно: Этот пакет сам установит все зависимости которые ему нужны, больше ничего ставить не требуется. Даже eslint.

Далее в корне проекта необходимо создать файл .eslintrc. В общем случае он будет выглядеть так:

{
 "extends": []
}

В этом массиве extends нужно перечислить конфиги, которые подходят вашему проекту:

• проект на чистом JavaScript: "extends": ["rtkit"]
• проект на чистом TypeScript: "extends": ["rtkit/ts"]
• проект на JavaScript + React: "extends": ["rtkit", "rtkit/react"]
• проект на TypeScript + React: "extends": ["rtkit/ts", "rtkit/react"]

Готово! Возможно понадобится перезагрузить вашу IDE или просто рестартнуть сервер eslint и все заработает.

Автофикс при сохранении файла в VS Code

В настройках VS Code (в формате JSON) вставьте следующие строки

"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
}

Семантичность версий

• patch - исправление багов, опечаток, оформление readme или package.json т.е. изменения не затрагивающие правила линтинга;
• minor - добавление/изменение правил в конфиг.
• major - Апдейт всех зависимостей пакета.