@alexlit/lint-kit 214.4.0 → 216.0.0

package/packages/config-eslint/index.js

@@ -1,3 +1,85 @@
+import { defineConfig as defineFlatConfig } from 'eslint/config';
+
+import { base } from './base.js';
+import { deMorgan } from './plugins/de-morgan.js';
+import { importX } from './plugins/import-x.js';
+import { javascript } from './plugins/javascript.js';
+import { jsdoc } from './plugins/jsdoc.js';
+import { json } from './plugins/json.js';
+import { perfectionist } from './plugins/perfectionist.js';
+import { pinia } from './plugins/pinia.js';
+import { prettier, prettierConfig } from './plugins/prettier.js';
+import { regexp } from './plugins/regexp.js';
+import { sonar } from './plugins/sonar.js';
+import { stylistic } from './plugins/stylistic.js';
+import { tailwindcss } from './plugins/tailwindcss.js';
+import { tanstackQuery } from './plugins/tanstack-query.js';
+import { typescriptTypeChecked } from './plugins/typescript-type-checked.js';
+import { typescript } from './plugins/typescript.js';
+import { unicorn } from './plugins/unicorn.js';
+import { unocss } from './plugins/unocss.js';
+import { vitest } from './plugins/vitest.js';
+import { vueAccessibility } from './plugins/vue-accessibility.js';
+import { vueI18n } from './plugins/vue-i18n.js';
+import { vue } from './plugins/vue.js';
+import { zod } from './plugins/zod.js';
+
+/**
+ * Фабрики плагинов. Каждый вызов возвращает массив flat-конфигов, который нужно
+ * развернуть через spread: `...plugins.<name>()`.
+ *
+ * Любая фабрика принимает необязательный конфиг, который добавляется после
+ * предустановленных блоков и переопределяет их.
+ */
+export const plugins = {
+  deMorgan,
+  importX,
+  javascript,
+  jsdoc,
+  json,
+  perfectionist,
+  pinia,
+  prettier,
+  prettierConfig,
+  regexp,
+  sonar,
+  stylistic,
+  tailwindcss,
+  tanstackQuery,
+  typescript,
+  typescriptTypeChecked,
+  unicorn,
+  unocss,
+  vitest,
+  vue,
+  vueAccessibility,
+  vueI18n,
+  zod,
+};
+
+/**
+ * Создать конфигурацию ESLint
+ *
+ * Базовые настройки (`base`) добавляются автоматически и всегда идут первыми.
+ * Разворачивайте вызовы плагинов через spread-оператор, а переопределения
+ * добавляйте прямо в массив.
+ *
+ * @example
+ *   import { defineConfig, plugins } from '@alexlit/config-eslint';
+ *
+ *   export default defineConfig([
+ *     ...plugins.javascript(),
+ *     ...plugins.unicorn({ rules: { 'unicorn/no-null': 'off' } }),
+ *     { rules: { 'no-console': 'off' } },
+ *     ...plugins.prettierConfig(), // последним
+ *   ]);
+ *
+ * @param {import('eslint').Linter.Config[]} [configs] - Массив flat-конфигов
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export const defineConfig = (configs = []) => defineFlatConfig([base, configs]);
+
 export {
   base,
   DATA_FILES,
@@ -10,28 +92,5 @@ export {
   VUE_FILES,
   YAML_FILES,
 } from './base.js';
-
-export { deMorgan } from './plugins/de-morgan.js';
-export { importX } from './plugins/import-x.js';
-export { javascript } from './plugins/javascript.js';
-export { jsdoc } from './plugins/jsdoc.js';
-export { json } from './plugins/json.js';
-export { perfectionist } from './plugins/perfectionist.js';
-export { pinia } from './plugins/pinia.js';
-export { prettier, prettierConfig } from './plugins/prettier.js';
-export { regexp } from './plugins/regexp.js';
-export { sonar } from './plugins/sonar.js';
-export { stylistic } from './plugins/stylistic.js';
-export { tailwindcss } from './plugins/tailwindcss.js';
-export { tanstackQuery } from './plugins/tanstack-query.js';
-export { typescriptTypeChecked } from './plugins/typescript-type-checked.js';
-export { typescript } from './plugins/typescript.js';
-export { unicorn } from './plugins/unicorn.js';
-export { unocss } from './plugins/unocss.js';
-export { vitest } from './plugins/vitest.js';
-export { vueAccessibility } from './plugins/vue-accessibility.js';
-export { vueI18n } from './plugins/vue-i18n.js';
-export { vue } from './plugins/vue.js';
-export { zod } from './plugins/zod.js';
 export { NO_RESTRICTED_SYNTAX } from './rules/restricted-syntax.js';
 export { TS_RULES } from './rules/typescript.js';

package/packages/config-eslint/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@alexlit/config-eslint",
-  "version": "161.4.0",
+  "version": "163.0.0",
   "private": false,
-  "description": "Sharable ESLint configuration",
+  "description": "eslint config",
   "keywords": [
+    "code-quality",
+    "config",
     "eslint",
     "eslint-config",
-    "lint",
-    "code-quality",
     "javascript",
+    "lint",
     "typescript"
   ],
   "homepage": "https://github.com/alex-lit/lint-kit/tree/master/packages/config-eslint#readme",
@@ -23,21 +24,23 @@
   "license": "MIT",
   "author": "Alexey Litovchenko <alex.lit@outlook.com> (https://github.com/alex-lit)",
   "type": "module",
-  "main": "./index.js",
+  "main": "index.js",
+  "types": "index.d.ts",
   "files": [
-    "index.js",
+    "README.md",
     "base.js",
+    "index.d.ts",
+    "index.js",
     "plugins/",
-    "rules/",
-    "README.md"
+    "rules/"
   ],
   "scripts": {
     "inspect": "npx @eslint/config-inspector@latest",
     "lint": "cd ../../ && ./scripts/lint.eslint.sh",
-    "ou": "sh ../../scripts/ou.sh",
-    "release": "sh ../../scripts/release.sh",
-    "semver": "sh ../../scripts/semver.sh",
-    "up": "sh ../../scripts/up.sh"
+    "ou": "../../scripts/ou.sh",
+    "release": "../../scripts/release.sh",
+    "semver": "../../scripts/semver.sh",
+    "up": "../../scripts/up.sh"
   },
   "dependencies": {
     "@eslint/js": "^10.0.1",
@@ -46,13 +49,13 @@
     "@stylistic/eslint-plugin": "^5.10.0",
     "@tanstack/eslint-plugin-query": "^5.104.5",
     "@unocss/eslint-config": "^66.11.0",
-    "@vitest/eslint-plugin": "^1.6.27",
+    "@vitest/eslint-plugin": "^1.6.28",
     "eslint": "^10.13.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-de-morgan": "^2.2.1",
     "eslint-plugin-import-x": "^4.17.1",
-    "eslint-plugin-jsdoc": "^65.3.15",
-    "eslint-plugin-perfectionist": "^5.12.1",
+    "eslint-plugin-jsdoc": "^65.4.1",
+    "eslint-plugin-perfectionist": "^5.13.0",
     "eslint-plugin-pinia": "^0.4.2",
     "eslint-plugin-prettier": "^5.5.7",
     "eslint-plugin-regexp": "^3.3.1",
@@ -60,8 +63,8 @@
     "eslint-plugin-tailwindcss": "^4.4.0",
     "eslint-plugin-unicorn": "^78.0.0",
     "eslint-plugin-vue": "^10.11.1",
-    "eslint-plugin-vuejs-accessibility": "^2.6.2",
-    "eslint-plugin-zod": "^5.2.0",
+    "eslint-plugin-vuejs-accessibility": "^2.6.3",
+    "eslint-plugin-zod": "^5.2.1",
     "globals": "^17.13.0",
     "jsonc-eslint-parser": "^3.3.0",
     "typescript": "^6.0.3",

package/packages/config-eslint/plugins/de-morgan.js

@@ -3,7 +3,14 @@ import { defineConfig } from 'eslint/config';
 
 import { FILES } from '../base.js';
 
-/** @see [eslint-plugin-de-morgan](https://github.com/azat-io/eslint-plugin-de-morgan) */
-export const deMorgan = defineConfig([
-  { files: FILES, ...plugin.configs.recommended },
-]);
+/**
+ * Упрощает логические выражения с помощью правила Де Моргана.
+ *
+ * @param {import('eslint').Linter.Config | import('eslint').Linter.Config[]} [config]
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint-plugin-de-morgan](https://github.com/azat-io/eslint-plugin-de-morgan)
+ */
+export const deMorgan = (config = []) =>
+  defineConfig([{ files: FILES, ...plugin.configs.recommended }, config]);

package/packages/config-eslint/plugins/import-x.js

@@ -18,44 +18,61 @@ const EXTENSIONS = [
   '.json',
 ];
 
-/** @see [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) */
-export const importX = defineConfig([
-  { ...plugin.flatConfigs.recommended, files: FILES, ignores: DATA_FILES },
+/**
+ * Правила для импортов и модулей.
+ *
+ * @param {import('eslint').Linter.Config | import('eslint').Linter.Config[]} [config]
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x)
+ */
+export const importX = (config = []) =>
+  defineConfig([
+    { ...plugin.flatConfigs.recommended, files: FILES, ignores: DATA_FILES },
 
-  {
-    files: FILES,
-    languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
-    plugins: { 'import-x': plugin },
-    rules: {
-      'import-x/consistent-type-specifier-style': ['error', 'prefer-top-level'],
-      'import-x/first': 'error',
-      'import-x/newline-after-import': 'warn',
-      'import-x/no-absolute-path': 'error',
-      'import-x/no-cycle': 'error',
-      'import-x/no-extraneous-dependencies': 'error',
-      'import-x/no-named-as-default': 'off',
-      'import-x/no-named-as-default-member': 'off',
-      'import-x/no-nodejs-modules': 'off',
-      'import-x/no-self-import': 'error',
-      'import-x/no-unresolved': 'off',
-      'import-x/no-useless-path-segments': ['error', { noUselessIndex: true }],
-      'import-x/unambiguous': 'error',
+    {
+      files: FILES,
+      languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
+      plugins: { 'import-x': plugin },
+      rules: {
+        'import-x/consistent-type-specifier-style': [
+          'error',
+          'prefer-top-level',
+        ],
+        'import-x/first': 'error',
+        'import-x/newline-after-import': 'warn',
+        'import-x/no-absolute-path': 'error',
+        'import-x/no-cycle': 'error',
+        'import-x/no-extraneous-dependencies': 'error',
+        'import-x/no-named-as-default': 'off',
+        'import-x/no-named-as-default-member': 'off',
+        'import-x/no-nodejs-modules': 'off',
+        'import-x/no-self-import': 'error',
+        'import-x/no-unresolved': 'off',
+        'import-x/no-useless-path-segments': [
+          'error',
+          { noUselessIndex: true },
+        ],
+        'import-x/unambiguous': 'error',
+      },
+      settings: {
+        'import-x/extensions': EXTENSIONS,
+        'import-x/ignore': ['node_modules', String.raw`\.vue$`],
+        'import-x/parsers': { '.vue': [vueParser] },
+        'import-x/resolver-next': [
+          createNodeResolver({ extensions: EXTENSIONS, tsconfig: 'auto' }),
+        ],
+      },
     },
-    settings: {
-      'import-x/extensions': EXTENSIONS,
-      'import-x/ignore': ['node_modules', String.raw`\.vue$`],
-      'import-x/parsers': { '.vue': [vueParser] },
-      'import-x/resolver-next': [
-        createNodeResolver({ extensions: EXTENSIONS, tsconfig: 'auto' }),
-      ],
-    },
-  },
 
-  {
-    files: VUE_FILES,
-    rules: {
-      'import-x/no-useless-path-segments': 'off',
-      'import-x/unambiguous': 'off',
+    {
+      files: VUE_FILES,
+      rules: {
+        'import-x/no-useless-path-segments': 'off',
+        'import-x/unambiguous': 'off',
+      },
     },
-  },
-]);
+
+    config,
+  ]);

package/packages/config-eslint/plugins/javascript.js

@@ -5,90 +5,105 @@ import { FILES, TEST_FILES } from '../base.js';
 import { NO_RESTRICTED_SYNTAX } from '../rules/restricted-syntax.js';
 import { STYLE_RULES } from '../rules/style.js';
 
-/** @see [eslint](https://eslint.org) */
-export const javascript = defineConfig([
-  { files: FILES, ...plugin.configs.recommended },
-  {
-    files: FILES,
-    rules: {
-      'arrow-body-style': ['error', 'as-needed'],
-      ...STYLE_RULES,
-      'default-case-last': 'error',
-      'dot-notation': ['error'],
-      'grouped-accessor-pairs': ['error', 'getBeforeSet'],
-      'no-alert': 'error',
-      'no-console': 'warn',
-      'no-duplicate-imports': [
-        'error',
-        { allowSeparateTypeImports: true, includeExports: false },
-      ],
-      'no-else-return': 'error',
-      'no-implicit-coercion': 'error',
-      'no-param-reassign': ['error', { props: false }],
-      'no-restricted-exports': [
-        'error',
-        {
-          restrictedNamedExports: ['then'],
-          restrictedNamedExportsPattern: '^_',
-        },
-      ],
-      'no-restricted-globals': [
-        'error',
-        // `event`, `top` and `parent` are global browser properties.
-        // Reach for `window.event` / `window.top` / `window.parent` instead.
-        { message: 'Use `window.event` instead.', name: 'event' },
-        { message: 'Use `window.parent` instead.', name: 'parent' },
-        { message: 'Use `window.top` instead.', name: 'top' },
-      ],
-      'no-restricted-imports': [
-        'error',
-        {
-          patterns: [
-            // Алиасы
-            { group: ['~/', '~~/'], message: 'Используйте "@" вместо "~".' },
-            // Расширения
-            {
-              message: 'Не указывайте расширения .ts или .js в путях импорта.',
-              regex: String.raw`\.[jt]sx?$`,
-            },
-            // Относительные импорты
-            { group: ['..', '*/..'], message: 'Используйте абсолютный путь.' },
-            {
-              message: 'Не используйте индексный импорт.',
-              regex: String.raw`^\.$`,
-            },
-            {
-              group: ['**/index'],
-              message: 'Не используйте индексный импорт.',
-            },
-            // Внешние локальные ресурсы
-            {
-              group: ['@/**/_*', '@@/**/_*', '~/**/_*', '~~/**/_*'],
-              message: 'Этот локальный ресурс не преднаназначен для импорта.',
-            },
-            // Устаревший функционал
-            {
-              message: 'Этот функционал устарел.',
-              regex: '(_deprecated|_legacy)',
-            },
-          ],
-        },
-      ],
-      'no-restricted-syntax': ['error', ...NO_RESTRICTED_SYNTAX],
-      'no-useless-rename': 'error',
-      'prefer-arrow-callback': [
-        'error',
-        { allowNamedFunctions: false, allowUnboundThis: false },
-      ],
-      'prefer-const': 'warn',
-      'prefer-template': 'warn',
-      'require-await': 'error',
+/**
+ * Базовые правила JavaScript.
+ *
+ * @param {import('eslint').Linter.Config | import('eslint').Linter.Config[]} [config]
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint](https://eslint.org)
+ */
+export const javascript = (config = []) =>
+  defineConfig([
+    { files: FILES, ...plugin.configs.recommended },
+    {
+      files: FILES,
+      rules: {
+        'arrow-body-style': ['error', 'as-needed'],
+        ...STYLE_RULES,
+        'default-case-last': 'error',
+        'dot-notation': ['error'],
+        'grouped-accessor-pairs': ['error', 'getBeforeSet'],
+        'no-alert': 'error',
+        'no-console': 'warn',
+        'no-duplicate-imports': [
+          'error',
+          { allowSeparateTypeImports: true, includeExports: false },
+        ],
+        'no-else-return': 'error',
+        'no-implicit-coercion': 'error',
+        'no-param-reassign': ['error', { props: false }],
+        'no-restricted-exports': [
+          'error',
+          {
+            restrictedNamedExports: ['then'],
+            restrictedNamedExportsPattern: '^_',
+          },
+        ],
+        'no-restricted-globals': [
+          'error',
+          // `event`, `top` and `parent` are global browser properties.
+          // Reach for `window.event` / `window.top` / `window.parent` instead.
+          { message: 'Use `window.event` instead.', name: 'event' },
+          { message: 'Use `window.parent` instead.', name: 'parent' },
+          { message: 'Use `window.top` instead.', name: 'top' },
+        ],
+        'no-restricted-imports': [
+          'error',
+          {
+            patterns: [
+              // Алиасы
+              { group: ['~/', '~~/'], message: 'Используйте "@" вместо "~".' },
+              // Расширения
+              {
+                message:
+                  'Не указывайте расширения .ts или .js в путях импорта.',
+                regex: String.raw`\.[jt]sx?$`,
+              },
+              // Относительные импорты
+              {
+                group: ['..', '*/..'],
+                message: 'Используйте абсолютный путь.',
+              },
+              {
+                message: 'Не используйте индексный импорт.',
+                regex: String.raw`^\.$`,
+              },
+              {
+                group: ['**/index'],
+                message: 'Не используйте индексный импорт.',
+              },
+              // Внешние локальные ресурсы
+              {
+                group: ['@/**/_*', '@@/**/_*', '~/**/_*', '~~/**/_*'],
+                message: 'Этот локальный ресурс не преднаназначен для импорта.',
+              },
+              // Устаревший функционал
+              {
+                message: 'Этот функционал устарел.',
+                regex: '(_deprecated|_legacy)',
+              },
+            ],
+          },
+        ],
+        'no-restricted-syntax': ['error', ...NO_RESTRICTED_SYNTAX],
+        'no-useless-rename': 'error',
+        'prefer-arrow-callback': [
+          'error',
+          { allowNamedFunctions: false, allowUnboundThis: false },
+        ],
+        'prefer-const': 'warn',
+        'prefer-template': 'warn',
+        'require-await': 'error',
+      },
     },
-  },
 
-  {
-    // Tests are allowed to log and to alert
-    files: TEST_FILES,
-    rules: { 'no-alert': 'off', 'no-console': 'off' },
-  },
-]);
+    {
+      // Tests are allowed to log and to alert
+      files: TEST_FILES,
+      rules: { 'no-alert': 'off', 'no-console': 'off' },
+    },
+
+    config,
+  ]);

package/packages/config-eslint/plugins/jsdoc.js

@@ -3,21 +3,32 @@ import { defineConfig } from 'eslint/config';
 
 import { FILES } from '../base.js';
 
-/** @see [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) */
-export const jsdoc = defineConfig([
-  { files: FILES, ...plugin.configs['flat/recommended'] },
-  {
-    files: FILES,
-    rules: {
-      'jsdoc/lines-before-block': 'off',
-      'jsdoc/no-undefined-types': 'off',
-      'jsdoc/require-jsdoc': 'off',
-      'jsdoc/require-param-description': 'off',
-      'jsdoc/require-param-type': 'off',
-      'jsdoc/require-returns': 'off',
-      'jsdoc/require-returns-description': 'off',
-      'jsdoc/require-returns-type': 'off',
-      'jsdoc/tag-lines': 'off',
+/**
+ * Правила для JSDoc-комментариев.
+ *
+ * @param {import('eslint').Linter.Config | import('eslint').Linter.Config[]} [config]
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc)
+ */
+export const jsdoc = (config = []) =>
+  defineConfig([
+    { files: FILES, ...plugin.configs['flat/recommended'] },
+    {
+      files: FILES,
+      rules: {
+        'jsdoc/lines-before-block': 'off',
+        'jsdoc/no-undefined-types': 'off',
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-param-description': 'off',
+        'jsdoc/require-param-type': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/require-returns-description': 'off',
+        'jsdoc/require-returns-type': 'off',
+        'jsdoc/tag-lines': 'off',
+      },
     },
-  },
-]);
+
+    config,
+  ]);

package/packages/config-eslint/plugins/json.js

@@ -4,30 +4,41 @@ import * as yamlParser from 'yaml-eslint-parser';
 
 import { YAML_FILES } from '../base.js';
 
-/** @see [ESLint/JSON](https://github.com/eslint/json) */
-export const json = defineConfig([
-  {
-    extends: ['json/recommended'],
-    files: ['**/*.json'],
-    ignores: ['**/package-lock.json'],
-    language: 'json/json',
-    plugins: { json: plugin },
-  },
+/**
+ * Правила для JSON, JSONC, JSON5 и YAML-файлов.
+ *
+ * @param {import('eslint').Linter.Config | import('eslint').Linter.Config[]} [config]
+ *
+ * @returns {import('eslint').Linter.Config[]}
+ *
+ * @see [ESLint/JSON](https://github.com/eslint/json)
+ */
+export const json = (config = []) =>
+  defineConfig([
+    {
+      extends: ['json/recommended'],
+      files: ['**/*.json'],
+      ignores: ['**/package-lock.json'],
+      language: 'json/json',
+      plugins: { json: plugin },
+    },
 
-  {
-    extends: ['json/recommended'],
-    files: ['**/*.jsonc'],
-    language: 'json/jsonc',
-    languageOptions: { allowTrailingCommas: true },
-    plugins: { json: plugin },
-  },
+    {
+      extends: ['json/recommended'],
+      files: ['**/*.jsonc'],
+      language: 'json/jsonc',
+      languageOptions: { allowTrailingCommas: true },
+      plugins: { json: plugin },
+    },
 
-  {
-    extends: ['json/recommended'],
-    files: ['**/*.json5'],
-    language: 'json/json5',
-    plugins: { json: plugin },
-  },
+    {
+      extends: ['json/recommended'],
+      files: ['**/*.json5'],
+      language: 'json/json5',
+      plugins: { json: plugin },
+    },
 
-  { files: YAML_FILES, languageOptions: { parser: yamlParser } },
-]);
+    { files: YAML_FILES, languageOptions: { parser: yamlParser } },
+
+    config,
+  ]);