@aarongoldenthal/eslint-config-standard 42.0.1 → 43.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aarongoldenthal/eslint-config-standard",
-  "version": "42.0.1",
+  "version": "43.0.0",
   "description": "Standard ESLint configuration settings",
   "type": "module",
   "scripts": {
@@ -32,17 +32,20 @@
     "./eslint-comments-config": "./eslint-comments-config.js",
     "./esm-config": "./esm-config.js",
     "./jest-config": "./jest-config.js",
-    "./jsdoc-config": "./jsdoc-config.js",
+    "./jsdoc-configs": "./jsdoc-configs.js",
     "./node-config": "./node-config.js",
     "./playwright-config": "./playwright-config.js",
     "./promise-config": "./promise-config.js",
     "./recommended": "./recommended.js",
     "./recommended-esm": "./recommended-esm.js",
+    "./recommended-ts": "./recommended-ts.js",
+    "./typescript-eslint-configs": "./typescript-eslint-configs.js",
     "./unicorn-configs": "./unicorn-configs.js",
     "./vitest-config": "./vitest-config.js"
   },
   "files": [
     "*-config*.js",
+    "settings.js",
     "recommended*.js"
   ],
   "bugs": {
@@ -51,26 +54,34 @@
   "homepage": "https://gitlab.com/gitlab-ci-utils/eslint-config-standard",
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-    "@vitest/eslint-plugin": "1.5.2",
+    "@vitest/eslint-plugin": "1.6.4",
     "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-jest": "29.2.2",
+    "eslint-plugin-jest": "29.11.2",
     "eslint-plugin-jsdoc": "61.5.0",
     "eslint-plugin-n": "17.23.1",
     "eslint-plugin-playwright": "2.4.0",
     "eslint-plugin-promise": "7.2.1",
     "eslint-plugin-unicorn": "62.0.0",
-    "globals": "16.5.0"
+    "globals": "16.5.0",
+    "typescript-eslint": "8.51.0"
   },
   "devDependencies": {
     "@eslint/config-inspector": "1.4.2",
-    "@vitest/coverage-v8": "4.0.15",
+    "@vitest/coverage-v8": "4.0.16",
     "eslint": "9.39.2",
     "jest": "30.2.0",
     "markdownlint-cli2": "0.20.0",
     "prettier": "3.7.4",
-    "vitest": "4.0.15"
+    "typescript": "5.9.3",
+    "vitest": "4.0.16"
   },
   "peerDependencies": {
-    "eslint": "^9.22.0"
+    "eslint": "^9.22.0",
+    "typescript": "^5.8.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
   }
 }

package/playwright-config.js

@@ -1,11 +1,12 @@
 import { defineConfig } from 'eslint/config';
+import { filePatterns } from './settings.js';
 import globals from 'globals';
 import playwrightPlugin from 'eslint-plugin-playwright';
 
 const maxExpects = 5;
 
 export default defineConfig({
-    files: ['**/*.pwtest.{js,mjs,cjs}'],
+    files: [...filePatterns.playwrightJs, ...filePatterns.playwrightTs],
     languageOptions: {
         globals: {
             ...globals['shared-node-browser']

package/promise-config.js

@@ -1,9 +1,10 @@
 import { defineConfig } from 'eslint/config';
+import { filePatterns } from './settings.js';
 import promisePlugin from 'eslint-plugin-promise';
 
 // Create local variable due to vitest v4 coverage changes
 const config = defineConfig({
-    files: ['**/*.{js,mjs,cjs}'],
+    files: [...filePatterns.allJs, ...filePatterns.allTs],
     name: 'promise (all files)',
     plugins: { promise: promisePlugin },
     rules: {

package/recommended-esm-base.js

@@ -0,0 +1,24 @@
+import baseConfigs from './base-configs.js';
+import eslintCommentsConfig from './eslint-comments-config.js';
+import esmConfig from './esm-config.js';
+import jsdocConfigs from './jsdoc-configs.js';
+import nodeConfig from './node-config.js';
+import playwrightConfig from './playwright-config.js';
+import promiseConfig from './promise-config.js';
+import unicornConfigs from './unicorn-configs.js';
+import vitestConfig from './vitest-config.js';
+
+// Create local variable due to vitest v4 coverage changes
+const baseConfig = [
+    eslintCommentsConfig,
+    jsdocConfigs,
+    nodeConfig,
+    playwrightConfig,
+    promiseConfig,
+    unicornConfigs,
+    vitestConfig,
+    baseConfigs,
+    esmConfig
+];
+
+export default baseConfig;

package/recommended-esm.js

@@ -1,28 +1,11 @@
 import { defineConfig } from 'eslint/config';
-
-import baseConfigs from './base-configs.js';
-import eslintCommentsConfig from './eslint-comments-config.js';
-import esmConfig from './esm-config.js';
-import jsdocConfig from './jsdoc-config.js';
-import nodeConfig from './node-config.js';
-import playwrightConfig from './playwright-config.js';
+import esmBaseConfig from './recommended-esm-base.js';
 import prettierConfig from 'eslint-config-prettier';
-import promiseConfig from './promise-config.js';
-import unicornConfigs from './unicorn-configs.js';
-import vitestConfig from './vitest-config.js';
 
 // Create local variable due to vitest v4 coverage changes
 const config = defineConfig([
-    eslintCommentsConfig,
-    jsdocConfig,
-    nodeConfig,
-    playwrightConfig,
-    promiseConfig,
-    unicornConfigs,
-    vitestConfig,
-    baseConfigs,
-    esmConfig,
-    prettierConfig
+    esmBaseConfig,
+    { name: 'prettier (all files)', ...prettierConfig }
 ]);
 
 export default config;

package/recommended-ts.js

@@ -0,0 +1,13 @@
+import { defineConfig } from 'eslint/config';
+import esmBaseConfig from './recommended-esm-base.js';
+import prettierConfig from 'eslint-config-prettier';
+import typescriptEslintConfigs from './typescript-eslint-configs.js';
+
+// Create local variable due to vitest v4 coverage changes
+const config = defineConfig([
+    esmBaseConfig,
+    typescriptEslintConfigs,
+    { name: 'prettier (all files)', ...prettierConfig }
+]);
+
+export default config;

package/recommended.js

@@ -3,7 +3,7 @@ import { defineConfig } from 'eslint/config';
 import baseConfigs from './base-configs.js';
 import eslintCommentsConfig from './eslint-comments-config.js';
 import jestConfig from './jest-config.js';
-import jsdocConfig from './jsdoc-config.js';
+import jsdocConfigs from './jsdoc-configs.js';
 import nodeConfig from './node-config.js';
 import playwrightConfig from './playwright-config.js';
 import prettierConfig from 'eslint-config-prettier';
@@ -14,7 +14,7 @@ import unicornConfigs from './unicorn-configs.js';
 const config = defineConfig([
     eslintCommentsConfig,
     jestConfig,
-    jsdocConfig,
+    jsdocConfigs,
     nodeConfig,
     playwrightConfig,
     promiseConfig,

package/settings.js

@@ -0,0 +1,31 @@
+const filePatterns = {
+    allJs: ['**/*.{js,mjs,cjs}'],
+    allTs: ['**/*.{ts,mts,cts}'],
+    baseJsTs: ['**/*.{js,ts}'],
+    commonJsTs: ['**/*.{cjs,cts}'],
+    esmJsTs: ['**/*.{mjs,mts}'],
+    playwrightJs: ['**/*.pwtest.{js,mjs,cjs}'],
+    playwrightTs: ['**/*.pwtest.{ts,mts,cts}'],
+    testAllJs: [
+        '**/__tests__/**/*.{js,mjs,cjs}',
+        '**/?(*.)+(spec|test).{js,mjs,cjs}'
+    ],
+    testAllTs: [
+        '**/__tests__/**/*.{ts,mts,cts}',
+        '**/?(*.)+(spec|test).{ts,mts,cts}'
+    ],
+    testEsmJs: ['**/__tests__/**/*.{js,mjs}', '**/?(*.)+(spec|test).{js,mjs}'],
+    testEsmTs: ['**/__tests__/**/*.{ts,mts}', '**/?(*.)+(spec|test).{ts,mts}']
+};
+
+const thresholds = {
+    complexityHigh: 15,
+    complexityLow: 5,
+    maxFunctionLines: 30,
+    maxLines: 300,
+    maxParameters: 4,
+    maxStatements: 50,
+    nested: 5
+};
+
+export { filePatterns, thresholds };

package/typescript-eslint-configs.js

@@ -0,0 +1,258 @@
+import { filePatterns, thresholds } from './settings.js';
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+// Rules with unfixable errors on *.{js,mjs,cjs} files
+const typescriptOnlyRules = {
+    '@typescript-eslint/explicit-function-return-type': 'error',
+    '@typescript-eslint/explicit-member-accessibility': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'error'
+};
+
+const typescriptTypedRules = {
+    '@typescript-eslint/await-thenable': 'error',
+    '@typescript-eslint/consistent-type-exports': 'error',
+    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/no-array-delete': 'error',
+    '@typescript-eslint/no-base-to-string': 'error',
+    '@typescript-eslint/no-confusing-void-expression': 'error',
+    '@typescript-eslint/no-deprecated': 'error',
+    '@typescript-eslint/no-duplicate-type-constituents': 'error',
+    '@typescript-eslint/no-floating-promises': 'error',
+    '@typescript-eslint/no-for-in-array': 'error',
+    '@typescript-eslint/no-meaningless-void-operator': 'error',
+    '@typescript-eslint/no-misused-promises': 'error',
+    '@typescript-eslint/no-misused-spread': 'error',
+    '@typescript-eslint/no-mixed-enums': 'error',
+    '@typescript-eslint/no-redundant-type-constituents': 'error',
+    '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+    '@typescript-eslint/no-unnecessary-condition': 'error',
+    '@typescript-eslint/no-unnecessary-qualifier': 'error',
+    '@typescript-eslint/no-unnecessary-template-expression': 'error',
+    '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    '@typescript-eslint/no-unnecessary-type-conversion': 'error',
+    '@typescript-eslint/no-unnecessary-type-parameters': 'error',
+    '@typescript-eslint/no-unsafe-argument': 'error',
+    '@typescript-eslint/no-unsafe-assignment': 'error',
+    '@typescript-eslint/no-unsafe-call': 'error',
+    '@typescript-eslint/no-unsafe-enum-comparison': 'error',
+    '@typescript-eslint/no-unsafe-member-access': 'error',
+    '@typescript-eslint/no-unsafe-return': 'error',
+    '@typescript-eslint/no-unsafe-type-assertion': 'error',
+    '@typescript-eslint/no-unsafe-unary-minus': 'error',
+    '@typescript-eslint/no-useless-default-assignment': 'error',
+    '@typescript-eslint/non-nullable-type-assertion-style': 'error',
+    '@typescript-eslint/prefer-find': 'error',
+    '@typescript-eslint/prefer-includes': 'error',
+    '@typescript-eslint/prefer-nullish-coalescing': 'error',
+    '@typescript-eslint/prefer-optional-chain': 'error',
+    '@typescript-eslint/prefer-readonly': 'error',
+    // Rule is very strict, lots of false positives
+    '@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',
+    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+    '@typescript-eslint/promise-function-async': 'error',
+    '@typescript-eslint/related-getter-setter-pairs': 'error',
+    '@typescript-eslint/require-array-sort-compare': 'error',
+    '@typescript-eslint/restrict-plus-operands': [
+        'error',
+        {
+            allowAny: false,
+            allowBoolean: false,
+            allowNullish: false,
+            allowNumberAndString: false,
+            allowRegExp: false
+        }
+    ],
+    '@typescript-eslint/restrict-template-expressions': [
+        'error',
+        {
+            allowAny: false,
+            allowBoolean: false,
+            allowNever: false,
+            allowNullish: false,
+            allowNumber: false,
+            allowRegExp: false
+        }
+    ],
+    '@typescript-eslint/return-await': [
+        'error',
+        'error-handling-correctness-only'
+    ],
+    '@typescript-eslint/strict-boolean-expressions': 'error',
+    '@typescript-eslint/switch-exhaustiveness-check': 'error',
+    '@typescript-eslint/unbound-method': 'error',
+    '@typescript-eslint/use-unknown-in-catch-callback-variable': 'error'
+};
+
+/* eslint-disable sort-keys -- keep rules in pairs*/
+const typescriptRulesExtendBaseRules = {
+    'class-methods-use-this': 'off',
+    '@typescript-eslint/class-methods-use-this': 'error',
+    // Disabled in favor of noImplicitReturns in tsconfig.json
+    'consistent-return': 'off',
+    '@typescript-eslint/consistent-return': 'off', // Typed rule
+    'default-param-last': 'off',
+    '@typescript-eslint/default-param-last': 'error',
+    'dot-notation': 'off',
+    '@typescript-eslint/dot-notation': [
+        'error',
+        { allowPattern: '^[a-z]+(_[a-z]+)+$' }
+    ], // Typed rule
+    'max-params': 'off',
+    '@typescript-eslint/max-params': [
+        'error',
+        { max: thresholds.maxParameters }
+    ],
+    camelcase: 'off',
+    '@typescript-eslint/naming-convention': [
+        'error',
+        {
+            format: ['camelCase'],
+            leadingUnderscore: 'forbid',
+            selector: 'default',
+            trailingUnderscore: 'forbid'
+        },
+        {
+            format: ['camelCase', 'PascalCase'],
+            selector: 'import'
+        },
+        {
+            format: ['camelCase', 'UPPER_CASE'],
+            selector: 'variable'
+        },
+        {
+            format: ['PascalCase'],
+            selector: 'typeLike'
+        }
+    ], // Typed rule
+    'no-array-constructor': 'off',
+    '@typescript-eslint/no-array-constructor': 'error',
+    'no-dupe-class-members': 'off',
+    '@typescript-eslint/no-dupe-class-members': 'error',
+    'no-empty-function': 'off',
+    '@typescript-eslint/no-empty-function': 'error',
+    'no-implied-eval': 'off',
+    '@typescript-eslint/no-implied-eval': 'error', // Typed rule
+    'no-loop-func': 'off',
+    '@typescript-eslint/no-loop-func': 'error',
+    'no-magic-numbers': 'off',
+    '@typescript-eslint/no-magic-numbers': ['error', { ignore: [-1, 0, 1] }], // Typed rule
+    'no-shadow': 'off',
+    '@typescript-eslint/no-shadow': 'error',
+    'no-throw-literal': 'off',
+    '@typescript-eslint/only-throw-error': 'error', // Typed rule
+    'no-unused-expressions': 'off',
+    '@typescript-eslint/no-unused-expressions': [
+        'error',
+        { allowShortCircuit: true, allowTernary: true }
+    ],
+    'no-unused-private-class-members': 'off',
+    '@typescript-eslint/no-unused-private-class-members': 'error',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', { args: 'all' }],
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': ['error', { functions: false }],
+    'no-useless-constructor': 'off',
+    '@typescript-eslint/no-useless-constructor': 'error',
+    'prefer-destructuring': 'off',
+    '@typescript-eslint/prefer-destructuring': [
+        'error',
+        { array: true, object: true }
+    ], // Typed rule
+    'prefer-promise-reject-errors': 'off',
+    '@typescript-eslint/prefer-promise-reject-errors': 'error', // Typed rule
+    'require-await': 'off',
+    '@typescript-eslint/require-await': 'error' // Typed rule
+};
+/* eslint-enable sort-keys -- keep rules in pairs*/
+
+const typescriptUntypedRules = {
+    '@typescript-eslint/adjacent-overload-signatures': 'error',
+    '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
+    '@typescript-eslint/ban-ts-comment': 'error',
+    '@typescript-eslint/ban-tslint-comment': 'error',
+    '@typescript-eslint/class-literal-property-style': 'error',
+    '@typescript-eslint/consistent-generic-constructors': 'error',
+    '@typescript-eslint/consistent-indexed-object-style': ['error', 'record'],
+    '@typescript-eslint/consistent-type-assertions': 'error',
+    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+    '@typescript-eslint/init-declarations': 'off',
+    '@typescript-eslint/member-ordering': 'error',
+    '@typescript-eslint/method-signature-style': ['error', 'method'],
+    '@typescript-eslint/no-confusing-non-null-assertion': 'error',
+    '@typescript-eslint/no-duplicate-enum-values': 'error',
+    '@typescript-eslint/no-dynamic-delete': 'error',
+    '@typescript-eslint/no-empty-object-type': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/no-extra-non-null-assertion': 'error',
+    '@typescript-eslint/no-extraneous-class': 'error',
+    '@typescript-eslint/no-import-type-side-effects': 'error',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-invalid-this': 'off',
+    '@typescript-eslint/no-invalid-void-type': 'error',
+    '@typescript-eslint/no-misused-new': 'error',
+    '@typescript-eslint/no-namespace': 'error',
+    '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+    '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'error',
+    '@typescript-eslint/no-redeclare': 'off',
+    '@typescript-eslint/no-require-imports': 'error', // ESM-only
+    '@typescript-eslint/no-restricted-imports': 'off',
+    '@typescript-eslint/no-restricted-types': 'off',
+    '@typescript-eslint/no-this-alias': 'error',
+    '@typescript-eslint/no-unnecessary-parameter-property-assignment': 'error',
+    '@typescript-eslint/no-unnecessary-type-constraint': 'error',
+    '@typescript-eslint/no-unsafe-declaration-merging': 'error',
+    '@typescript-eslint/no-unsafe-function-type': 'error',
+    '@typescript-eslint/no-useless-empty-export': 'error',
+    '@typescript-eslint/no-wrapper-object-types': 'error',
+    '@typescript-eslint/parameter-properties': 'error',
+    '@typescript-eslint/prefer-as-const': 'error',
+    '@typescript-eslint/prefer-enum-initializers': 'error',
+    '@typescript-eslint/prefer-for-of': 'error',
+    '@typescript-eslint/prefer-function-type': 'error',
+    '@typescript-eslint/prefer-literal-enum-member': 'error',
+    '@typescript-eslint/prefer-namespace-keyword': 'error',
+    '@typescript-eslint/triple-slash-reference': 'error',
+    '@typescript-eslint/unified-signatures': 'error'
+};
+
+export default defineConfig([
+    {
+        files: [...filePatterns.allTs],
+        languageOptions: {
+            parser: tseslint.parser,
+            parserOptions: {
+                projectService: true
+            }
+        },
+        name: 'typescript-eslint parser and TS-specific rules',
+        rules: {
+            ...typescriptOnlyRules,
+            ...typescriptTypedRules,
+            ...typescriptRulesExtendBaseRules
+        }
+    },
+    {
+        files: [...filePatterns.allJs, ...filePatterns.allTs],
+        name: 'typescript-eslint untyped rules (js/ts)',
+        // Set the plugin here so applicable to all TS and JS files.
+        plugins: {
+            '@typescript-eslint': tseslint.plugin
+        },
+        rules: {
+            ...typescriptUntypedRules
+        }
+    },
+    {
+        files: [...filePatterns.commonJsTs],
+        name: 'typescript-eslint untyped cjs rules (cjs/cts)',
+        rules: {
+            '@typescript-eslint/no-require-imports': 'off'
+        }
+    }
+]);

package/unicorn-configs.js

@@ -1,10 +1,11 @@
 import { defineConfig } from 'eslint/config';
+import { filePatterns } from './settings.js';
 import unicornPlugin from 'eslint-plugin-unicorn';
 
 // Create local variable due to vitest v4 coverage changes
 const config = defineConfig([
     {
-        files: ['**/*.{js,mjs,cjs}'],
+        files: [...filePatterns.allJs, ...filePatterns.allTs],
         name: 'unicorn (all files)',
         plugins: { unicorn: unicornPlugin },
         rules: {
@@ -164,10 +165,11 @@ const config = defineConfig([
     {
         files: [
             // Patterns for jest-config, vitest-config
-            '**/__tests__/**/*.{js,mjs,cjs}',
-            '**/?(*.)+(spec|test).{js,mjs,cjs}',
+            ...filePatterns.testAllJs,
+            ...filePatterns.testAllTs,
             // Pattern for playwright-config
-            '**/*.pwtest.{js,mjs,cjs}'
+            ...filePatterns.playwrightJs,
+            ...filePatterns.playwrightTs
         ],
         name: 'unicorn (test files)',
         rules: {
@@ -177,8 +179,8 @@ const config = defineConfig([
         }
     },
     {
-        files: ['**/*.mjs'],
-        name: 'esm (mjs files)',
+        files: [...filePatterns.esmJsTs],
+        name: 'esm (mjs/mts files)',
         rules: {
             'unicorn/prefer-module': 'error',
             'unicorn/prefer-top-level-await': 'error'

package/vitest-config.js

@@ -1,17 +1,27 @@
 import { defineConfig } from 'eslint/config';
+import { filePatterns } from './settings.js';
 import vitestPlugin from '@vitest/eslint-plugin';
 
 // Create local variable due to vitest v4 coverage changes
 const config = defineConfig({
-    files: ['**/__tests__/**/*.{js,mjs}', '**/?(*.)+(spec|test).{js,mjs}'],
+    files: [...filePatterns.testEsmJs, ...filePatterns.testEsmTs],
     name: 'vitest (test files)',
     plugins: { vitest: vitestPlugin },
     rules: {
+        'vitest/consistent-each-for': [
+            'error',
+            {
+                describe: 'each',
+                it: 'each',
+                suite: 'each',
+                test: 'each'
+            }
+        ],
         'vitest/consistent-test-filename': [
             'error',
             {
-                allTestPattern: String.raw`.*\.test\.(js|mjs)$`,
-                pattern: String.raw`.*\.test\.(js|mjs)$`
+                allTestPattern: String.raw`.*\.test\.(js|mjs|ts|mts)$`,
+                pattern: String.raw`.*\.test\.(js|mjs|ts|mts)$`
             }
         ],
         'vitest/consistent-test-it': [
@@ -65,6 +75,7 @@ const config = defineConfig({
         'vitest/prefer-importing-vitest-globals': 'error',
         'vitest/prefer-lowercase-title': 'error',
         'vitest/prefer-mock-promise-shorthand': 'error',
+        'vitest/prefer-mock-return-shorthand': 'error',
         'vitest/prefer-snapshot-hint': 'error',
         'vitest/prefer-spy-on': 'error',
         'vitest/prefer-strict-equal': 'error',
@@ -73,6 +84,7 @@ const config = defineConfig({
         'vitest/prefer-to-be-object': 'error',
         'vitest/prefer-to-be-truthy': 'off',
         'vitest/prefer-to-contain': 'error',
+        'vitest/prefer-to-have-been-called-times': 'error',
         'vitest/prefer-to-have-length': 'error',
         'vitest/prefer-todo': 'error',
         'vitest/prefer-vi-mocked': 'error',