eslint-config-ksv741/README.md at 2a4bce3e85ce7c818e1f980d4ad9ac554f33a4a4

Sergey Krylov 2a4bce3e85 feat: add eslint 9 support, update dependencies

BREAKING CHANGE: not support eslint 8 versions and lower

2024-11-01 07:37:54 +03:00

5.3 KiB

Raw Blame History

eslint-config-ksv741

Конфиг eslint для JavaScript, TypeScript, React, Jest

Содержание

Установка
Использование
Настройка
Кастомизация
Плагины

Установка

npm

npm install --save-dev eslint-config-ksv741

yarn

yarn add --dev eslint-config-ksv741

pnpm

pnpm add --save-dev eslint-config-ksv741

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

Для подключения - добавьте конфиг в файл конфигурации Eslint

// eslint.config.js

const config = require('eslint-config-ksv741');

module.exports = [
  ...config,
];

Доступны следующие конфиги:

js-base - содержит правила для файлов JavaScript
js-react - содержит правила для файлов JavaScript и правила для JSX и React
ts-base - содержит правила для файлов JavaScript и правила для файлов TypeScript
ts-react - содержит правила для файлов JavaScript, TypeScript, JSX и React
jest - содержит правила для Jest
default - содержит правила для файлов JavaScript, TypeScript, JSX, React, Jest - Рекомендуется использовать

Настройка

Можно точечно переопределить для каких файлов использовать определенный конфиг

// eslint.config.js

const jsBase = require('eslint-config-ksv741/js-base');
const jsReact = require('eslint-config-ksv741/js-react');
const tsBase = require('eslint-config-ksv741/ts-base');
const tsReact = require('eslint-config-ksv741/ts-react');
const jest = require('eslint-config-ksv741/jest');

module.exports = [
    {
      files: ["*.js"],
      ...jsBase
    },
    {
      files: ["*.jsx"],
      ...jsReact
    },
    {
      files: ["*.ts"],
      ...tsBase
    },
    {
      files: ["*.tsx"],
      ...tsReact
    },
    {
      files: [
        "**/__tests__/**/*.[jt]s?(x)",
        "**/?(*.)+(spec|test).[jt]s?(x)"
      ],
      ...jest
    }
  ]

Кастомизация

Для файлов, использующих конфигурацию ts-base или ts-react по умолчанию используется @typescript-eslint/parser и eslint-import-resolver-typescript. Но вы можете это переопределить, используя настройки плагина eslint-plugin-import

ВНИМАНИЕ
Для проектов использующих TypeScript предустановлены @typescript-eslint/parser и eslint-import-resolver-typescript. Алиасы путей обычно хранятся в настройке paths файла tsconfig.json

По умолчанию, для файлов .js, .jsx не предустановлен парсер и плагин для разрешения путей, т.к. в зависимости от проекта инструменты могут значительно отличаться, предполагается что эта настройка будет установлена самостоятельно.

5.3 KiB Raw Blame History Unescape Escape