@alexlit/config-eslint 161.4.0 → 162.1.0

package/plugins/prettier.js

@@ -17,14 +17,28 @@ const fixes = {
   ],
 };
 
-/** @see [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) */
-export const prettier = defineConfig([
-  { files: FILES, ...plugin, rules: { ...plugin.rules, ...STYLE_RULES } },
-  { files: VUE_FILES, rules: { ...fixes } },
-]);
+/**
+ * Форматирование кода самим Prettier (ESLint запускает Prettier как правило).
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier)
+ */
+export const prettier = () =>
+  defineConfig([
+    { files: FILES, ...plugin, rules: { ...plugin.rules, ...STYLE_RULES } },
+    { files: VUE_FILES, rules: { ...fixes } },
+  ]);
 
-/** @see [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) */
-export const prettierConfig = defineConfig([
-  { files: FILES, ...config, rules: { ...config.rules, ...STYLE_RULES } },
-  { files: VUE_FILES, rules: { ...fixes } },
-]);
+/**
+ * Отключение правил, конфликтующих с Prettier.
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
+ */
+export const prettierConfig = () =>
+  defineConfig([
+    { files: FILES, ...config, rules: { ...config.rules, ...STYLE_RULES } },
+    { files: VUE_FILES, rules: { ...fixes } },
+  ]);

package/plugins/regexp.js

@@ -3,13 +3,20 @@ import { defineConfig } from 'eslint/config';
 
 import { FILES } from '../base.js';
 
-/** @see [eslint-plugin-regexp](https://github.com/ota-meshi/eslint-plugin-regexp) */
-export const regexp = defineConfig([
-  {
-    files: FILES,
-    ...plugin.configs['flat/recommended'],
-    settings: {
-      regexp: { allowedCharacterRanges: ['alphanumeric', 'а-я', 'А-Я'] },
+/**
+ * Правила для регулярных выражений.
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint-plugin-regexp](https://github.com/ota-meshi/eslint-plugin-regexp)
+ */
+export const regexp = () =>
+  defineConfig([
+    {
+      files: FILES,
+      ...plugin.configs['flat/recommended'],
+      settings: {
+        regexp: { allowedCharacterRanges: ['alphanumeric', 'а-я', 'А-Я'] },
+      },
     },
-  },
-]);
+  ]);

package/plugins/sonar.js

@@ -3,16 +3,23 @@ import { defineConfig } from 'eslint/config';
 
 import { FILES } from '../base.js';
 
-/** @see [eslint-plugin-sonarjs](https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md) */
-export const sonar = defineConfig([
-  {
-    files: FILES,
-    ...plugin.configs.recommended,
-    rules: {
-      ...plugin.configs.recommended.rules,
-      'sonarjs/no-commented-code': 'warn',
-      'sonarjs/todo-tag': 'off',
-      'sonarjs/unused-import': 'off', // @typescript-eslint/no-unused-vars
+/**
+ * Правила SonarJS.
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint-plugin-sonarjs](https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md)
+ */
+export const sonar = () =>
+  defineConfig([
+    {
+      files: FILES,
+      ...plugin.configs.recommended,
+      rules: {
+        ...plugin.configs.recommended.rules,
+        'sonarjs/no-commented-code': 'warn',
+        'sonarjs/todo-tag': 'off',
+        'sonarjs/unused-import': 'off', // @typescript-eslint/no-unused-vars
+      },
     },
-  },
-]);
+  ]);

package/plugins/stylistic.js

@@ -3,104 +3,111 @@ import { defineConfig } from 'eslint/config';
 
 import { DATA_FILES, FILES } from '../base.js';
 
-/** @see [@stylistic/eslint-plugin](https://eslint.style/) */
-export const stylistic = defineConfig([
-  {
-    ...plugin.configs.recommended,
-    ignores: [...(plugin.configs.recommended.ignores ?? []), ...DATA_FILES],
-  },
-  {
-    files: FILES,
-    plugins: { '@stylistic': plugin },
-    rules: {
-      '@stylistic/lines-around-comment': [
-        'warn',
-        {
-          afterBlockComment: false,
-          afterHashbangComment: true,
-          afterLineComment: false,
-          allowArrayEnd: true,
-          allowArrayStart: true,
-          allowBlockEnd: true,
-          allowBlockStart: true,
-          allowClassEnd: true,
-          allowClassStart: true,
-          allowEnumEnd: true,
-          allowEnumStart: true,
-          allowInterfaceEnd: true,
-          allowInterfaceStart: true,
-          allowModuleEnd: true,
-          allowModuleStart: true,
-          allowObjectEnd: true,
-          allowObjectStart: true,
-          allowTypeEnd: true,
-          allowTypeStart: true,
-          applyDefaultIgnorePatterns: true,
-          beforeBlockComment: false,
-          beforeLineComment: false,
-        },
-      ],
-      '@stylistic/padding-line-between-statements': [
-        'warn',
-        // always
-        { blankLine: 'always', next: '*', prev: 'block-like' },
-        { blankLine: 'always', next: '*', prev: 'case' },
-        { blankLine: 'always', next: '*', prev: 'cjs-export' },
-        { blankLine: 'always', next: '*', prev: 'cjs-import' },
-        { blankLine: 'always', next: '*', prev: 'class' },
-        { blankLine: 'always', next: '*', prev: 'default' },
-        { blankLine: 'always', next: '*', prev: 'directive' },
-        { blankLine: 'always', next: '*', prev: 'enum' },
-        { blankLine: 'always', next: '*', prev: 'export' },
-        { blankLine: 'always', next: '*', prev: 'expression' },
-        { blankLine: 'always', next: '*', prev: 'iife' },
-        { blankLine: 'always', next: '*', prev: 'import' },
-        { blankLine: 'always', next: '*', prev: 'interface' },
-        { blankLine: 'always', next: '*', prev: 'multiline-block-like' },
-        { blankLine: 'always', next: '*', prev: 'multiline-const' },
-        { blankLine: 'always', next: '*', prev: 'multiline-expression' },
-        { blankLine: 'always', next: '*', prev: 'multiline-let' },
-        { blankLine: 'always', next: '*', prev: 'multiline-var' },
-        { blankLine: 'always', next: '*', prev: 'singleline-const' },
-        { blankLine: 'always', next: '*', prev: 'singleline-let' },
-        { blankLine: 'always', next: '*', prev: 'singleline-var' },
-        { blankLine: 'always', next: '*', prev: 'type' },
-        { blankLine: 'always', next: 'block-like', prev: '*' },
-        { blankLine: 'always', next: 'cjs-export', prev: '*' },
-        { blankLine: 'always', next: 'cjs-import', prev: '*' },
-        { blankLine: 'always', next: 'class', prev: '*' },
-        { blankLine: 'always', next: 'enum', prev: '*' },
-        { blankLine: 'always', next: 'export', prev: '*' },
-        { blankLine: 'always', next: 'expression', prev: '*' },
-        { blankLine: 'always', next: 'function', prev: '*' },
-        { blankLine: 'always', next: 'iife', prev: '*' },
-        { blankLine: 'always', next: 'import', prev: '*' },
-        { blankLine: 'always', next: 'interface', prev: '*' },
-        { blankLine: 'always', next: 'multiline-block-like', prev: '*' },
-        { blankLine: 'always', next: 'multiline-const', prev: '*' },
-        { blankLine: 'always', next: 'multiline-expression', prev: '*' },
-        { blankLine: 'always', next: 'multiline-let', prev: '*' },
-        { blankLine: 'always', next: 'multiline-var', prev: '*' },
-        { blankLine: 'always', next: 'return', prev: '*' },
-        { blankLine: 'always', next: 'switch', prev: '*' },
-        { blankLine: 'always', next: 'type', prev: '*' },
-        // any
-        { blankLine: 'any', next: 'expression', prev: 'expression' },
-        {
-          blankLine: 'any',
-          next: 'singleline-const',
-          prev: 'singleline-const',
-        },
-        { blankLine: 'any', next: 'export', prev: 'export' },
-        { blankLine: 'any', next: 'import', prev: 'import' },
-        { blankLine: 'any', next: 'singleline-let', prev: 'singleline-let' },
-        { blankLine: 'any', next: 'singleline-var', prev: 'singleline-var' },
-        // never
-        { blankLine: 'never', next: 'cjs-export', prev: 'cjs-export' },
-        { blankLine: 'never', next: 'cjs-import', prev: 'cjs-import' },
-        { blankLine: 'never', next: 'directive', prev: 'directive' },
-        { blankLine: 'never', next: 'function', prev: 'function-overload' },
-      ],
+/**
+ * Правила форматирования и стиля кода.
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [@stylistic/eslint-plugin](https://eslint.style/)
+ */
+export const stylistic = () =>
+  defineConfig([
+    {
+      ...plugin.configs.recommended,
+      ignores: [...(plugin.configs.recommended.ignores ?? []), ...DATA_FILES],
     },
-  },
-]);
+    {
+      files: FILES,
+      plugins: { '@stylistic': plugin },
+      rules: {
+        '@stylistic/lines-around-comment': [
+          'warn',
+          {
+            afterBlockComment: false,
+            afterHashbangComment: true,
+            afterLineComment: false,
+            allowArrayEnd: true,
+            allowArrayStart: true,
+            allowBlockEnd: true,
+            allowBlockStart: true,
+            allowClassEnd: true,
+            allowClassStart: true,
+            allowEnumEnd: true,
+            allowEnumStart: true,
+            allowInterfaceEnd: true,
+            allowInterfaceStart: true,
+            allowModuleEnd: true,
+            allowModuleStart: true,
+            allowObjectEnd: true,
+            allowObjectStart: true,
+            allowTypeEnd: true,
+            allowTypeStart: true,
+            applyDefaultIgnorePatterns: true,
+            beforeBlockComment: false,
+            beforeLineComment: false,
+          },
+        ],
+        '@stylistic/padding-line-between-statements': [
+          'warn',
+          // always
+          { blankLine: 'always', next: '*', prev: 'block-like' },
+          { blankLine: 'always', next: '*', prev: 'case' },
+          { blankLine: 'always', next: '*', prev: 'cjs-export' },
+          { blankLine: 'always', next: '*', prev: 'cjs-import' },
+          { blankLine: 'always', next: '*', prev: 'class' },
+          { blankLine: 'always', next: '*', prev: 'default' },
+          { blankLine: 'always', next: '*', prev: 'directive' },
+          { blankLine: 'always', next: '*', prev: 'enum' },
+          { blankLine: 'always', next: '*', prev: 'export' },
+          { blankLine: 'always', next: '*', prev: 'expression' },
+          { blankLine: 'always', next: '*', prev: 'iife' },
+          { blankLine: 'always', next: '*', prev: 'import' },
+          { blankLine: 'always', next: '*', prev: 'interface' },
+          { blankLine: 'always', next: '*', prev: 'multiline-block-like' },
+          { blankLine: 'always', next: '*', prev: 'multiline-const' },
+          { blankLine: 'always', next: '*', prev: 'multiline-expression' },
+          { blankLine: 'always', next: '*', prev: 'multiline-let' },
+          { blankLine: 'always', next: '*', prev: 'multiline-var' },
+          { blankLine: 'always', next: '*', prev: 'singleline-const' },
+          { blankLine: 'always', next: '*', prev: 'singleline-let' },
+          { blankLine: 'always', next: '*', prev: 'singleline-var' },
+          { blankLine: 'always', next: '*', prev: 'type' },
+          { blankLine: 'always', next: 'block-like', prev: '*' },
+          { blankLine: 'always', next: 'cjs-export', prev: '*' },
+          { blankLine: 'always', next: 'cjs-import', prev: '*' },
+          { blankLine: 'always', next: 'class', prev: '*' },
+          { blankLine: 'always', next: 'enum', prev: '*' },
+          { blankLine: 'always', next: 'export', prev: '*' },
+          { blankLine: 'always', next: 'expression', prev: '*' },
+          { blankLine: 'always', next: 'function', prev: '*' },
+          { blankLine: 'always', next: 'iife', prev: '*' },
+          { blankLine: 'always', next: 'import', prev: '*' },
+          { blankLine: 'always', next: 'interface', prev: '*' },
+          { blankLine: 'always', next: 'multiline-block-like', prev: '*' },
+          { blankLine: 'always', next: 'multiline-const', prev: '*' },
+          { blankLine: 'always', next: 'multiline-expression', prev: '*' },
+          { blankLine: 'always', next: 'multiline-let', prev: '*' },
+          { blankLine: 'always', next: 'multiline-var', prev: '*' },
+          { blankLine: 'always', next: 'return', prev: '*' },
+          { blankLine: 'always', next: 'switch', prev: '*' },
+          { blankLine: 'always', next: 'type', prev: '*' },
+          // any
+          { blankLine: 'any', next: 'expression', prev: 'expression' },
+          {
+            blankLine: 'any',
+            next: 'singleline-const',
+            prev: 'singleline-const',
+          },
+          { blankLine: 'any', next: 'export', prev: 'export' },
+          { blankLine: 'any', next: 'import', prev: 'import' },
+          { blankLine: 'any', next: 'singleline-let', prev: 'singleline-let' },
+          { blankLine: 'any', next: 'singleline-var', prev: 'singleline-var' },
+          // never
+          { blankLine: 'never', next: 'cjs-export', prev: 'cjs-export' },
+          { blankLine: 'never', next: 'cjs-import', prev: 'cjs-import' },
+          { blankLine: 'never', next: 'directive', prev: 'directive' },
+          { blankLine: 'never', next: 'function', prev: 'function-overload' },
+        ],
+      },
+    },
+  ]);

package/plugins/tailwindcss.js

@@ -3,19 +3,30 @@ import { defineConfig } from 'eslint/config';
 
 import { FILES } from '../base.js';
 
+const DEFAULT_CSS_CONFIG_PATH = './styles/tailwind.css';
+
 /**
+ * Правила для Tailwind CSS.
+ *
  * @example
  *   import path from 'node:path';
+ *   import { defineConfig, plugins } from '@alexlit/config-eslint';
+ *
+ *   export default defineConfig([
+ *     plugins.tailwindcss({
+ *       cssConfigPath: path.resolve(import.meta.dirname, 'src/styles.css'),
+ *     }),
+ *   ]);
  *
- *   tailwindcss({
- *     cssConfigPath: path.resolve(import.meta.dirname, 'src/tailwind.css'),
- *   });
+ * @param {import('eslint-plugin-tailwindcss').PluginSettings} [settings] -
+ *   Настройки плагина `tailwindcss`. По умолчанию `cssConfigPath` равен
+ *   `./styles/tailwind.css`.
  *
- * @param settings {import('eslint-plugin-tailwindcss').PluginSettings}
+ * @returns {import('eslint').Linter.Config[]}
  *
  * @see [eslint-plugin-tailwindcss](https://github.com/francoismassart/eslint-plugin-tailwindcss)
  */
-export const tailwindcss = (settings) =>
+export const tailwindcss = (settings = {}) =>
   defineConfig([
     {
       files: FILES,
@@ -27,7 +38,7 @@ export const tailwindcss = (settings) =>
       },
       settings: {
         /** @type {import('eslint-plugin-tailwindcss').PluginSettings} */
-        tailwindcss: { cssConfigPath: './styles/tailwind.css', ...settings },
+        tailwindcss: { cssConfigPath: DEFAULT_CSS_CONFIG_PATH, ...settings },
       },
     },
   ]);

package/plugins/tanstack-query.js

@@ -3,12 +3,19 @@ import { defineConfig } from 'eslint/config';
 
 import { DATA_FILES } from '../base.js';
 
-/** @see [@tanstack/query](https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query) */
-export const tanstackQuery = defineConfig([
-  // The shipped config has no `files` key, so it would also cover data files.
-  ...plugin.configs['flat/recommended'].map((config) => ({
-    ...config,
-    ignores: [...(config.ignores ?? []), ...DATA_FILES],
-  })),
-  { rules: { '@tanstack/query/infinite-query-property-order': 'off' } },
-]);
+/**
+ * Правила для TanStack Query.
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [@tanstack/query](https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query)
+ */
+export const tanstackQuery = () =>
+  defineConfig([
+    // The shipped config has no `files` key, so it would also cover data files.
+    ...plugin.configs['flat/recommended'].map((config) => ({
+      ...config,
+      ignores: [...(config.ignores ?? []), ...DATA_FILES],
+    })),
+    { rules: { '@tanstack/query/infinite-query-property-order': 'off' } },
+  ]);

package/plugins/typescript-type-checked.js

@@ -5,46 +5,51 @@ import { DATA_FILES, FILES, TEST_FILES, TS_FILES } from '../base.js';
 import { TS_RULES } from '../rules/typescript.js';
 
 /**
- * Type-aware TypeScript config.
+ * Type-aware правила TypeScript.
  *
  * Opt-in: requires a `tsconfig.json` in the project and needs type information,
  * which makes linting slower. Use it instead of `typescript`, not alongside
  * it.
  *
+ * @returns {import('eslint').Linter.Config[]}
+ *
  * @see [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)
  */
-export const typescriptTypeChecked = defineConfig([
-  // The parser is needed for every JS/TS/Vue file, not only for TypeScript ones,
-  // otherwise `.js` files fall back to the default parser and modern syntax
-  // (`import.meta`, top-level await) breaks.
-  { ...plugin.configs.base, files: FILES },
+export const typescriptTypeChecked = () =>
+  defineConfig([
+    // The parser is needed for every JS/TS/Vue file, not only for TypeScript ones,
+    // otherwise `.js` files fall back to the default parser and modern syntax
+    // (`import.meta`, top-level await) breaks.
+    { ...plugin.configs.base, files: FILES },
 
-  // Non type-aware rules — the same scope as the regular `typescript` plugin,
-  // so `.js`/`.vue` files keep the TypeScript versions of the rules.
-  // `plugin.configs.strict`/`stylistic` contain blocks without a `files` key,
-  // so they would also land on data files that are not JavaScript at all.
-  ...[...plugin.configs.strict, ...plugin.configs.stylistic].map((config) => ({
-    ...config,
-    ignores: [...(config.ignores ?? []), ...DATA_FILES],
-  })),
+    // Non type-aware rules - the same scope as the regular `typescript` plugin,
+    // so `.js`/`.vue` files keep the TypeScript versions of the rules.
+    // `plugin.configs.strict`/`stylistic` contain blocks without a `files` key,
+    // so they would also land on data files that are not JavaScript at all.
+    ...[...plugin.configs.strict, ...plugin.configs.stylistic].map(
+      (config) => ({
+        ...config,
+        ignores: [...(config.ignores ?? []), ...DATA_FILES],
+      }),
+    ),
 
-  // Type-aware rules only make sense where the type information is available.
-  ...plugin.configs.strictTypeChecked.map((config) => ({
-    ...config,
-    files: TS_FILES,
-  })),
-  ...plugin.configs.stylisticTypeChecked.map((config) => ({
-    ...config,
-    files: TS_FILES,
-  })),
+    // Type-aware rules only make sense where the type information is available.
+    ...plugin.configs.strictTypeChecked.map((config) => ({
+      ...config,
+      files: TS_FILES,
+    })),
+    ...plugin.configs.stylisticTypeChecked.map((config) => ({
+      ...config,
+      files: TS_FILES,
+    })),
 
-  {
-    files: TS_FILES,
-    languageOptions: { parserOptions: { projectService: true } },
-    rules: TS_RULES,
-  },
-  {
-    files: TEST_FILES,
-    rules: { '@typescript-eslint/no-empty-function': 'off' },
-  },
-]);
+    {
+      files: TS_FILES,
+      languageOptions: { parserOptions: { projectService: true } },
+      rules: TS_RULES,
+    },
+    {
+      files: TEST_FILES,
+      rules: { '@typescript-eslint/no-empty-function': 'off' },
+    },
+  ]);

package/plugins/typescript.js

@@ -4,18 +4,27 @@ import plugin from 'typescript-eslint';
 import { DATA_FILES, FILES, TEST_FILES } from '../base.js';
 import { TS_RULES } from '../rules/typescript.js';
 
-/** @see [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) */
-export const typescript = defineConfig([
-  // `plugin.configs.strict`/`stylistic` contain blocks without a `files` key,
-  // so they would also land on data files that are not JavaScript at all.
-  ...[...plugin.configs.strict, ...plugin.configs.stylistic].map((config) => ({
-    ...config,
-    ignores: [...(config.ignores ?? []), ...DATA_FILES],
-  })),
+/**
+ * Правила TypeScript без анализа типов.
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)
+ */
+export const typescript = () =>
+  defineConfig([
+    // `plugin.configs.strict`/`stylistic` contain blocks without a `files` key,
+    // so they would also land on data files that are not JavaScript at all.
+    ...[...plugin.configs.strict, ...plugin.configs.stylistic].map(
+      (config) => ({
+        ...config,
+        ignores: [...(config.ignores ?? []), ...DATA_FILES],
+      }),
+    ),
 
-  { files: FILES, rules: TS_RULES },
-  {
-    files: TEST_FILES,
-    rules: { '@typescript-eslint/no-empty-function': 'off' },
-  },
-]);
+    { files: FILES, rules: TS_RULES },
+    {
+      files: TEST_FILES,
+      rules: { '@typescript-eslint/no-empty-function': 'off' },
+    },
+  ]);