@mikey-pro/eslint-config 8.1.0 → 9.0.0

package/overrides.js

@@ -1,42 +1,72 @@
+// Modern overrides for different file types and frameworks
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import typescriptParser from '@typescript-eslint/parser';
-import typeScriptPlugin from '@typescript-eslint/eslint-plugin';
+
+import html from '@html-eslint/eslint-plugin';
+import htmlParser from '@html-eslint/parser';
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import cypress from 'eslint-plugin-cypress';
 import importPlugin from 'eslint-plugin-import';
-import markdownPlugin from 'eslint-plugin-markdownlint';
-import jestPlugin from 'eslint-plugin-jest';
+import jest from 'eslint-plugin-jest';
+import markdownlint from 'eslint-plugin-markdownlint';
+import jsoncParser from 'jsonc-eslint-parser';
+import tomlParser from 'toml-eslint-parser';
+import yamlParser from 'yaml-eslint-parser';
 
-const currentDir = path.dirname(fileURLToPath(import.meta.url));
+const currentDirectory = import.meta.dirname;
 
-const ts = {
-  files: ['*.ts', '*.tsx'],
+// TypeScript configuration
+export const ts = {
+  files: ['**/*.ts', '**/*.tsx'],
   languageOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
     ecmaVersion: 'latest',
-    extraFileExtensions: ['.vue', '.svelte'],
+    parser: tsParser,
+    parserOptions: {
+      ecmaFeatures: { jsx: true },
+      extraFileExtensions: ['.vue', '.svelte'],
+      project: path.join(currentDirectory, '../../tsconfig.json'),
+      tsconfigRootDir: path.join(currentDirectory, '../..'),
+    },
     sourceType: 'module',
-    project: 'tsconfig.json',
-    tsconfigRootDir: path.join(currentDir, '../../..'),
   },
   plugins: {
-    '@typescript-eslint': typeScriptPlugin,
+    '@typescript-eslint': tsPlugin,
     import: importPlugin,
   },
   rules: {
-    ...typeScriptPlugin.configs.all.rules,
-    ...typeScriptPlugin.configs['recommended-requiring-type-checking'].rules,
+    // TypeScript-specific rules
+    ...tsPlugin.configs.all.rules,
+    ...tsPlugin.configs['recommended-requiring-type-checking'].rules,
     ...importPlugin.configs.typescript.rules,
+
+    // Override some rules for better developer experience
     '@typescript-eslint/class-methods-use-this': 'off',
+    '@typescript-eslint/consistent-generic-constructors': [
+      'error',
+      'constructor',
+    ],
+    '@typescript-eslint/consistent-indexed-object-style': ['error', 'record'],
+    '@typescript-eslint/consistent-type-assertions': [
+      'error',
+      { assertionStyle: 'as', objectLiteralTypeAssertions: 'never' },
+    ],
+    '@typescript-eslint/consistent-type-exports': [
+      'error',
+      { fixMixedExportsWithInlineTypeSpecifier: true },
+    ],
     '@typescript-eslint/consistent-type-imports': [
       'error',
       {
-        prefer: 'type-imports',
-        fixStyle: 'separate-type-imports',
         disallowTypeAnnotations: false,
+        fixStyle: 'separate-type-imports',
+        prefer: 'type-imports',
       },
     ],
+    '@typescript-eslint/explicit-function-return-type': [
+      'warn',
+      { allowExpressions: true, allowTypedFunctionExpressions: true },
+    ],
     '@typescript-eslint/explicit-member-accessibility': [
       'warn',
       {
@@ -45,8 +75,8 @@ const ts = {
           accessors: 'explicit',
           constructors: 'no-public',
           methods: 'explicit',
-          properties: 'off',
           parameterProperties: 'explicit',
+          properties: 'off',
         },
       },
     ],
@@ -74,202 +104,182 @@ const ts = {
         ],
       },
     ],
+    '@typescript-eslint/method-signature-style': ['error', 'property'],
     '@typescript-eslint/naming-convention': [
       'error',
+      { format: ['PascalCase'], selector: ['typeLike'] },
+      { format: ['PascalCase'], prefix: ['T'], selector: ['typeParameter'] },
       {
-        selector: ['typeLike'],
-        format: ['PascalCase']
-      },
-      {
-        selector: ['typeParameter'],
-        format: ['PascalCase'],
-        prefix: ['T']
-      },
-      {
-        selector: ['interface'],
-        format: ['PascalCase'],
         custom: {
-          regex: '^I[A-Z]',
           match: false,
-          message: 'Interface name should not be prefixed with "I"'
-        }
-      }
+          regex: '^I[A-Z]',
+        },
+        format: ['PascalCase'],
+        selector: ['interface'],
+      },
     ],
+    '@typescript-eslint/no-confusing-void-expression': [
+      'error',
+      { ignoreArrowShorthand: true },
+    ],
+    '@typescript-eslint/no-explicit-any': 'warn',
     '@typescript-eslint/no-extraneous-class': [
       'warn',
       {
-        allowEmpty: true,
         allowConstructorOnly: false,
+        allowEmpty: true,
         allowStaticOnly: false,
         allowWithDecorator: false,
       },
     ],
-    '@typescript-eslint/no-inferrable-types': 'off',
-    '@typescript-eslint/no-magic-numbers': 'off',
-    '@typescript-eslint/no-unnecessary-condition': 'off',
-    '@typescript-eslint/parameter-properties': ['error', { prefer: 'parameter-property' }],
-    '@typescript-eslint/prefer-nullish-coalescing': 'off',
-    '@typescript-eslint/prefer-readonly': 'off',
-    '@typescript-eslint/prefer-readonly-parameter-types': 'off',
-    '@typescript-eslint/strict-boolean-expressions': 'off',
-    '@typescript-eslint/unbound-method': 'off',
-    '@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
-    '@typescript-eslint/consistent-type-assertions': [
-      'error',
-      {
-        assertionStyle: 'as',
-        objectLiteralTypeAssertions: 'never',
-      },
-    ],
-    '@typescript-eslint/explicit-function-return-type': [
-      'warn',
-      {
-        allowExpressions: true,
-        allowTypedFunctionExpressions: true,
-      },
-    ],
-    '@typescript-eslint/no-explicit-any': 'warn',
     '@typescript-eslint/no-floating-promises': 'error',
     '@typescript-eslint/no-for-in-array': 'error',
     '@typescript-eslint/no-import-type-side-effects': 'error',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-magic-numbers': 'off',
     '@typescript-eslint/no-misused-promises': [
       'error',
-      {
-        checksVoidReturn: false,
-      },
+      { checksVoidReturn: false },
     ],
-    '@typescript-eslint/no-unnecessary-type-constraint': 'error',
+    '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+    '@typescript-eslint/no-redundant-type-constituents': 'error',
     '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+    '@typescript-eslint/no-unnecessary-condition': 'off',
     '@typescript-eslint/no-unnecessary-qualifier': 'error',
+    '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+    '@typescript-eslint/no-unnecessary-type-constraint': 'error',
+    '@typescript-eslint/no-unsafe-argument': 'error',
     '@typescript-eslint/no-unsafe-declaration-merging': 'error',
     '@typescript-eslint/no-unsafe-enum-comparison': 'error',
-    '@typescript-eslint/prefer-optional-chain': 'error',
+    '@typescript-eslint/no-unsafe-member-access': 'error',
+    '@typescript-eslint/no-unsafe-unary-minus': 'error',
+    '@typescript-eslint/parameter-properties': [
+      'error',
+      { prefer: 'parameter-property' },
+    ],
+    '@typescript-eslint/prefer-enum-initializers': 'error',
+    '@typescript-eslint/prefer-find': 'error',
+    '@typescript-eslint/prefer-includes': 'error',
+    '@typescript-eslint/prefer-literal-enum-member': 'error',
+    '@typescript-eslint/prefer-nullish-coalescing': 'off',
+    '@typescript-eslint/prefer-optional-chain': [
+      'error',
+      {
+        checkAny: true,
+        checkBigInt: true,
+        checkBoolean: true,
+        checkNumber: true,
+        checkString: true,
+        checkUnknown: true,
+      },
+    ],
+    '@typescript-eslint/prefer-readonly': 'off',
+    '@typescript-eslint/prefer-readonly-parameter-types': 'off',
     '@typescript-eslint/prefer-reduce-type-parameter': 'error',
+    '@typescript-eslint/prefer-regexp-exec': 'error',
     '@typescript-eslint/prefer-return-this-type': 'error',
-    'deprecation/deprecation': 'warn',
-    'prettier/prettier': ['warn', { parser: 'typescript' }],
-    '@typescript-eslint/consistent-indexed-object-style': ['error', 'record'],
-    '@typescript-eslint/consistent-generic-constructors': ['error', 'constructor'],
-    '@typescript-eslint/no-confusing-void-expression': [
+    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+    '@typescript-eslint/prefer-ts-expect-error': 'error',
+    '@typescript-eslint/promise-function-async': [
       'error',
-      { ignoreArrowShorthand: true }
+      {
+        checkArrowFunctions: true,
+        checkFunctionDeclarations: true,
+        checkFunctionExpressions: true,
+        checkMethodDeclarations: true,
+      },
     ],
-    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
-    '@typescript-eslint/promise-function-async': 'error',
     '@typescript-eslint/require-array-sort-compare': [
       'error',
-      { ignoreStringArrays: true }
+      { ignoreStringArrays: true },
     ],
+    '@typescript-eslint/sort-type-constituents': 'error',
     '@typescript-eslint/strict-boolean-expressions': [
       'error',
       {
-        allowString: false,
+        allowNullableObject: false,
         allowNumber: false,
-        allowNullableObject: false
-      }
+        allowString: false,
+      },
     ],
-    '@typescript-eslint/method-signature-style': ['error', 'property'],
-    '@typescript-eslint/prefer-enum-initializers': 'error',
-    '@typescript-eslint/prefer-literal-enum-member': 'error',
-    '@typescript-eslint/prefer-ts-expect-error': 'error',
-    '@typescript-eslint/sort-type-constituents': 'error',
     '@typescript-eslint/switch-exhaustiveness-check': 'error',
-    '@typescript-eslint/prefer-optional-chain': ['error', {
-      checkAny: true,
-      checkUnknown: true,
-      checkString: true,
-      checkNumber: true,
-      checkBoolean: true,
-      checkBigInt: true
-    }],
-    '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
-    '@typescript-eslint/no-redundant-type-constituents': 'error',
-    '@typescript-eslint/no-unsafe-unary-minus': 'error',
-    '@typescript-eslint/no-useless-template-literals': 'error',
-    '@typescript-eslint/prefer-find': 'error',
-    '@typescript-eslint/consistent-type-exports': [
-      'error',
-      { fixMixedExportsWithInlineTypeSpecifier: true }
-    ],
-    '@typescript-eslint/no-unnecessary-type-arguments': 'error',
-    '@typescript-eslint/no-unsafe-argument': 'error',
-    '@typescript-eslint/no-unsafe-member-access': 'error',
-    '@typescript-eslint/prefer-includes': 'error',
-    '@typescript-eslint/prefer-regexp-exec': 'error',
-    '@typescript-eslint/promise-function-async': ['error', {
-      checkArrowFunctions: true,
-      checkFunctionDeclarations: true,
-      checkFunctionExpressions: true,
-      checkMethodDeclarations: true
-    }]
+    '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
   },
   settings: {
     'import/parsers': {
       '@typescript-eslint/parser': ['.ts', '.tsx', '.d.ts'],
     },
     'import/resolver': {
-      typescript: {
-        alwaysTryTypes: true,
-      },
+      typescript: { alwaysTryTypes: true },
     },
   },
 };
 
-const css = {
-  files: ['*.css'],
+// CSS files
+export const css = {
+  files: ['**/*.css'],
   rules: {
     'prettier/prettier': ['warn', { parser: 'css' }],
   },
 };
 
-const scss = {
-  files: ['*.scss'],
+// SCSS files
+export const scss = {
+  files: ['**/*.scss'],
   rules: {
     'prettier/prettier': ['warn', { parser: 'scss' }],
   },
 };
 
-const less = {
-  files: ['*.less'],
+// Less files
+export const less = {
+  files: ['**/*.less'],
   rules: {
     'prettier/prettier': ['warn', { parser: 'less' }],
   },
 };
 
-const yaml = {
-  extends: ['plugin:yml/standard'],
-  files: ['*.yaml', '*.yml'],
-  parser: 'yaml-eslint-parser',
+// YAML files
+export const yaml = {
+  files: ['**/*.yaml', '**/*.yml'],
+  languageOptions: {
+    parser: yamlParser,
+  },
   rules: {
-    'yml/quotes': ['warn', { prefer: 'double', avoidEscape: true }],
     'prettier/prettier': ['warn', { parser: 'yaml', singleQuote: false }],
+    'yml/quotes': ['warn', { avoidEscape: true, prefer: 'double' }],
   },
 };
 
-const toml = {
-  extends: ['plugin:toml/standard'],
-  files: ['*.toml'],
-  parser: 'toml-eslint-parser',
+// TOML files
+export const toml = {
+  files: ['**/*.toml'],
+  languageOptions: {
+    parser: tomlParser,
+  },
   rules: {
     'prettier/prettier': 'off',
   },
 };
 
-const md = {
-  files: ['*.md'],
+// Markdown files
+export const md = {
+  files: ['**/*.md'],
   plugins: {
-    markdownlint: markdownPlugin,
+    markdownlint,
   },
   rules: {
-    ...markdownPlugin.configs.recommended.rules,
+    ...markdownlint.configs.recommended.rules,
     'markdownlint/md033': 'off',
     'markdownlint/md041': 'off',
     'prettier/prettier': ['warn', { parser: 'markdown' }],
   },
 };
 
-const packageJson = {
-  files: ['package.json'],
+// Package.json files
+export const packageJson = {
+  files: ['**/package.json'],
   rules: {
     'prettier/prettier': ['warn', { parser: 'json' }],
   },
@@ -305,106 +315,101 @@ const packageJson = {
   },
 };
 
-const mdJson = {
-  files: ['*.md.json'],
-  rules: {
-    'prettier/prettier': ['warn', { parser: 'json' }],
+// HTML files
+export const htmlConfig = {
+  files: ['**/*.html'],
+  languageOptions: {
+    parser: htmlParser,
+  },
+  plugins: {
+    '@html-eslint': html,
   },
-};
-
-const html = {
-  files: ['*.html'],
-  extends: ['plugin:@html-eslint/recommended'],
-  parser: '@html-eslint/parser',
-  plugins: ['@html-eslint'],
   rules: {
+    ...html.configs.recommended.rules,
     '@html-eslint/element-newline': 'off',
     '@html-eslint/indent': 'off',
     '@html-eslint/no-extra-spacing-attrs': 'off',
     '@html-eslint/require-closing-tags': 'off',
-    'disable-autofix/@html-eslint/require-closing-tags': [
-      'warn',
-      { selfClosing: 'always' },
-    ],
+    'prettier/prettier': ['warn', { parser: 'html' }],
     'spaced-comment': 'off',
     strict: 'off',
-    'prettier/prettier': ['warn', { parser: 'html' }],
   },
 };
 
-const jsonc = {
-  extends: ['plugin:jsonc/recommended-with-jsonc'],
-  files: ['*.jsonc', '*rc'],
-  parser: 'jsonc-eslint-parser',
+// JSONC files
+export const jsonc = {
+  files: ['**/*.jsonc', '**/*rc'],
+  languageOptions: {
+    parser: jsoncParser,
+  },
   rules: {
     'prettier/prettier': ['warn', { parser: 'json' }],
   },
 };
 
-const json5 = {
-  extends: ['plugin:jsonc/recommended-with-json5'],
-  files: ['*.json5'],
-  parser: 'jsonc-eslint-parser',
+// JSON5 files
+export const json5 = {
+  files: ['**/*.json5'],
+  languageOptions: {
+    parser: jsoncParser,
+  },
   rules: {
     'prettier/prettier': ['warn', { parser: 'json5' }],
   },
 };
 
-const jestJs = {
-  files: ['*.test.js', '**/__tests__/**/*.js'],
-  plugins: {
-    jest: jestPlugin,
+// Jest JavaScript files
+export const jestJs = {
+  files: ['**/*.test.js', '**/__tests__/**/*.js'],
+  languageOptions: {
+    globals: { jest: true },
   },
-  extends: ['plugin:jest/all'],
-  env: {
-    jest: true,
+  plugins: {
+    jest,
   },
   rules: {
+    ...jest.configs.all.rules,
     'jest/prefer-spy-on': 'warn',
     'jest/require-top-level-describe': 'error',
-    'unicorn/no-array-callback-reference': 'off',
     'jest/unbound-method': 'off',
-    'unicorn/prevent-abbreviations': [
-      'warn',
-      {
-        ignore: [/e2e/],
-      }
-    ],
+    'unicorn/no-array-callback-reference': 'off',
+    'unicorn/prevent-abbreviations': ['warn', { ignore: [/e2e/] }],
   },
 };
 
-const jestTs = {
-  files: ['*.test.ts', '**/__tests__/**/*.ts'],
-  parser: '@typescript-eslint/parser',
-  plugins: {
-    '@typescript-eslint': typeScriptPlugin,
-    jest: jestPlugin,
+// Jest TypeScript files
+export const jestTs = {
+  files: ['**/*.test.ts', '**/__tests__/**/*.ts'],
+  languageOptions: {
+    globals: { jest: true },
+    parser: tsParser,
   },
-  extends: ['plugin:jest/all'],
-  env: {
-    jest: true,
+  plugins: {
+    '@typescript-eslint': tsPlugin,
+    jest,
   },
   rules: {
+    ...jest.configs.all.rules,
     'jest/prefer-spy-on': 'warn',
     'jest/require-top-level-describe': 'error',
-    'unicorn/no-array-callback-reference': 'off',
     'jest/unbound-method': 'off',
-    'unicorn/prevent-abbreviations': [
-      'warn',
-      {
-        ignore: [/e2e/],
-      }
-    ],
+    'unicorn/no-array-callback-reference': 'off',
+    'unicorn/prevent-abbreviations': ['warn', { ignore: [/e2e/] }],
   },
 };
 
-const cypress = {
-  mdJson,
-  files: ['*.cy.*'],
-  plugins: ['cypress'],
-  extends: ['plugin:cypress/recommended'],
+// Cypress files
+export const cypressConfig = {
+  files: ['**/*.cy.*'],
+  plugins: {
+    cypress,
+  },
+  rules: {
+    ...cypress.configs.recommended.rules,
+  },
 };
 
+// Export all overrides
 export const baseOverrides = [
   ts,
   css,
@@ -414,11 +419,10 @@ export const baseOverrides = [
   toml,
   md,
   packageJson,
-  mdJson,
-  html,
+  htmlConfig,
   jsonc,
   json5,
   jestJs,
   jestTs,
-  cypress,
+  cypressConfig,
 ];