README.md

Eslint config

Установка

npm install eslint @ptsecurity/eslint-config --save-dev

Использование

.eslintrc.js проекта должен выглядеть так:

module.exports = {
    extends: '@ptsecurity/eslint-config'
}

Можно подключать наборы правил, или конфигурации для плагинов отдельно

// .eslintrc.js
module.exports = {
    extends: [
        '@ptsecurity/eslint-config/base',
        '@ptsecurity/eslint-config/core/best-practices',
        '@ptsecurity/eslint-config/plugins/typescript-eslint',
        '@ptsecurity/eslint-config/plugins/import'
    ]
};

Описание

Пакет содержит конфигурацию eslint, подключаемую в проект.

Изменение конфигурации

Стандартные конфигурации для js и ts находятся в overrides/. Собственные конфигурации можно создавать по аналогии с уже имеющимися стандартными, используя утилиты load-core, load-plugins, находящиеся в utils.

Так же можно подключить частичные наборы правил (core), либо конфигурации для плагинов (plugins). За основу можно взять базовый конфиг base.js

Философия

• Конфигурация правил должна требовать минимальных усилий, работать из коробки.
• Линтинг не должен мешать разработчику. Например, не давать пройти локальной сборке или прервать сборку в CI.
• Errors должны указывать только на недопустимый или сломанный код.
• Warrnings должны указывать только на потенциальные ошибки или сбивающий с толку код.
• Все варианты форматирования и стилистики должны автоматически определяться инструментами.

Plugins

Перечень используемых плагинов

В данный момент в конфигурацию включены следующие плагины:

• typescript-eslint
• array-func
• eslint-comments
• import
• angular-eslint
• rxjs
• prefer-arrow
• prettier

Полезные ссылки

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

Code Quality

• eslint-plugin-unicorn

Languages

Следующие плагины расширяют ESLint для работы с файлами json и lint JavaScript, содержащимися в HTML и MarkDown:

• eslint-plugin-html
• eslint-plugin-json
• eslint-plugin-markdown

Library Plugins

• eslint-plugin-fsa
• eslint-plugin-lodash
• eslint-plugin-lodash-fp
• eslint-plugin-react-redux
• eslint-plugin-redux-saga

Practices

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

• eslint-plugin-array-func
• eslint-plugin-eslint-comments
• eslint-plugin-no-constructor-bind
• eslint-plugin-no-use-extend-native
• eslint-plugin-optimize-regex
• eslint-plugin-promise
• eslint-plugin-simple-import-sort
• eslint-plugin-switch-case

Security

• eslint-plugin-no-secrets
• eslint-plugin-no-unsanitized
• eslint-plugin-radar

Test Libraries

• eslint-plugin-jest
• eslint-plugin-jest-async
• eslint-plugin-cypress