@ololoepepe/eslint-config-typescript 0.0.11 → 0.1.1

package/src/index.js

@@ -1,316 +1,88 @@
-import pluginImport from '#src/plugins/import.js';
+/* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access --
+   The ESLint plugins and parser registered in this wiring file are untyped
+   third-party modules, so the typed-linting rules treat them as `any`. Suppress
+   the unsafe-access reports for the whole file. */
+import eslintComments from '@eslint-community/eslint-plugin-eslint-comments';
+import stylistic from '@stylistic/eslint-plugin';
+import importX from 'eslint-plugin-import-x';
+import perfectionist from 'eslint-plugin-perfectionist';
+import promise from 'eslint-plugin-promise';
+import regexp from 'eslint-plugin-regexp';
+import sortKeysShorthand from 'eslint-plugin-sort-keys-shorthand';
+import unicorn from 'eslint-plugin-unicorn';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+import pluginEslintComments from '#src/plugins/eslint-comments.js';
+import pluginImportX from '#src/plugins/import-x.js';
 import pluginPerfectionist from '#src/plugins/perfectionist.js';
+import pluginPromise from '#src/plugins/promise.js';
+import pluginRegexp from '#src/plugins/regexp.js';
 import pluginSortKeysShorthand from '#src/plugins/sort-keys-shorthand.js';
+import pluginStylistic from '#src/plugins/stylistic.js';
 import pluginTypescript from '#src/plugins/typescript/index.js';
+import pluginUnicorn from '#src/plugins/unicorn.js';
+import rulesCore from '#src/rules/core.js';
 import rulesNo from '#src/rules/no.js';
 
-export const env = {
-  es2021: true,
-  node: true
-};
-
-export const parser = '@typescript-eslint/parser';
-
-export const parserOptions = {
-  ecmaFeatures: {
-    jsx: true
-  },
-  ecmaVersion: 'latest',
-  project: './tsconfig.json',
-  requireConfigFile: false,
-  sourceType: 'module'
-};
-
-export const plugins = [
-  '@typescript-eslint',
-  'import',
-  'perfectionist',
-  'sort-keys-shorthand'
-];
-
-// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-export const rules = {
-  'accessor-pairs': ['warn', {
-    enforceForClassMembers: true,
-    getWithoutSet: false,
-    setWithoutGet: true
-  }],
-  'array-bracket-newline': ['error', 'consistent'],
-  'array-bracket-spacing': ['error', 'never', {
-    arraysInArrays: false,
-    objectsInArrays: false,
-    singleValue: false
-  }],
-  'array-callback-return': ['error', {
-    allowImplicit: false,
-    checkForEach: false
-  }],
-  'array-element-newline': ['error', 'consistent'],
-  'arrow-body-style': ['error', 'as-needed'],
-  'arrow-parens': ['error', 'as-needed', {
-    requireForBlockBody: false
-  }],
-  'arrow-spacing': ['error', {
-    after: true,
-    before: true
-  }],
-  'block-scoped-var': 'error',
-  'block-spacing': ['error', 'always'],
-  'brace-style': ['error', '1tbs', {
-    allowSingleLine: false
-  }],
-  camelcase: ['error', {
-    ignoreDestructuring: false,
-    ignoreGlobals: true,
-    ignoreImports: false,
-    properties: 'never'
-  }],
-  'capitalized-comments': ['error', 'always', {
-    ignoreConsecutiveComments: true,
-    ignoreInlineComments: false,
-    ignorePattern: 'webpackChunkName'
-  }],
-  'class-methods-use-this': 'off',
-  'comma-dangle': ['error', 'never'],
-  'comma-spacing': ['error', {
-    after: true,
-    before: false
-  }],
-  'comma-style': ['error', 'last'],
-  complexity: ['warn', 20],
-  'computed-property-spacing': ['error', 'never', {
-    enforceForClassMembers: true
-  }],
-  'consistent-return': 'off',
-  'consistent-this': ['error', 'self'],
-  'constructor-super': 'error',
-  curly: ['error', 'all'],
-  'default-case': 'off',
-  'default-case-last': 'error',
-  'default-param-last': 'error',
-  'dot-location': ['error', 'property'],
-  'dot-notation': 'off', // NOTE: See TypeScript rule extending this one
-  'eol-last': ['error', 'always'],
-  eqeqeq: ['error', 'always'],
-  'for-direction': 'error',
-  'func-call-spacing': ['error', 'never'],
-  'func-name-matching': ['warn', 'always'],
-  'func-names': ['error', 'never', {
-    generators: 'never'
-  }],
-  'func-style': ['error', 'declaration', {
-    allowArrowFunctions: true
-  }],
-  'function-call-argument-newline': ['error', 'consistent'],
-  'function-paren-newline': ['error', 'multiline-arguments'],
-  'generator-star-spacing': ['error', {
-    after: true,
-    before: true
-  }],
-  'getter-return': ['error', {
-    allowImplicit: false
-  }],
-  'grouped-accessor-pairs': ['error', 'getBeforeSet'],
-  'guard-for-in': 'error',
-  'id-denylist': 'off',
-  'id-length': 'off',
-  'id-match': 'off',
-  'implicit-arrow-linebreak': ['error', 'beside'],
-  indent: ['error', 2],
-  'init-declarations': 'off', // NOTE: See TypeScript rule extending this one
-  'jsx-quotes': ['error', 'prefer-double'],
-  'key-spacing': ['error', {
-    afterColon: true,
-    beforeColon: false
-  }],
-  'keyword-spacing': ['error', {
-    after: true,
-    before: true
-  }],
-  'line-comment-position': 'off',
-  'linebreak-style': ['error', 'unix'],
-  'lines-around-comment': 'off',
-  'lines-between-class-members': ['error', 'always', {
-    exceptAfterSingleLine: true
-  }],
-  'logical-assignment-operators': ['error', 'always', {
-    enforceForIfStatements: false
-  }],
-  'max-classes-per-file': 'off',
-  'max-depth': ['warn', 5],
-  'max-len': ['error', {
-    code: 120,
-    comments: 120,
-    ignoreComments: false,
-    ignoreRegExpLiterals: false,
-    ignoreStrings: false,
-    ignoreTemplateLiterals: false,
-    ignoreTrailingComments: false,
-    ignoreUrls: false,
-    tabWidth: 2
-  }],
-  'max-lines': ['warn', {
-    max: 500,
-    skipBlankLines: true,
-    skipComments: true
-  }],
-  'max-lines-per-function': ['warn', {
-    IIFEs: true,
-    max: 100,
-    skipBlankLines: true,
-    skipComments: true
-  }],
-  'max-nested-callbacks': ['warn', 5],
-  'max-params': 'off', // NOTE: See TypeScript rule extending this one
-  'max-statements': 'off',
-  'max-statements-per-line': ['error', {
-    max: 1
-  }],
-  'multiline-comment-style': 'off',
-  'multiline-ternary': 'off',
-  'new-cap': ['error', {
-    capIsNew: true,
-    newIsCap: true,
-    properties: true
-  }],
-  'new-parens': ['error', 'always'],
-  'newline-per-chained-call': ['error', {
-    ignoreChainWithDepth: 3
-  }],
-  'nonblock-statement-body-position': 'off',
-  'object-curly-newline': 'off',
-  'object-curly-spacing': ['error', 'never', {
-    arraysInObjects: false,
-    objectsInObjects: false
-  }],
-  'object-property-newline': 'off', // Reconsider
-  'object-shorthand': ['error', 'always', {
-    avoidExplicitReturnArrows: false,
-    avoidQuotes: true,
-    ignoreConstructors: false
-  }],
-  'one-var': ['error', 'never'],
-  'one-var-declaration-per-line': 'off',
-  'operator-assignment': ['error', 'always'],
-  'operator-linebreak': ['error', 'after'],
-  'padded-blocks': ['error', 'never', {
-    allowSingleLineBlocks: false
-  }],
-  'padding-line-between-statements': ['error', {
-    blankLine: 'always',
-    next: '*',
-    prev: 'multiline-block-like'
-  }],
-  'prefer-arrow-callback': ['error', {
-    allowNamedFunctions: false,
-    allowUnboundThis: true
-  }],
-  'prefer-const': ['error', {
-    destructuring: 'all',
-    ignoreReadBeforeAssign: true
-  }],
-  'prefer-destructuring': 'off', // NOTE: See TypeScript rule extending this one
-  'prefer-exponentiation-operator': 'error',
-  'prefer-named-capture-group': 'warn',
-  'prefer-numeric-literals': 'error',
-  'prefer-object-has-own': 'off',
-  'prefer-object-spread': 'error',
-  'prefer-promise-reject-errors': 'off', // NOTE: See TypeScript rule extending this one
-  'prefer-regex-literals': ['error', {
-    disallowRedundantWrapping: true
-  }],
-  'prefer-rest-params': 'error',
-  'prefer-spread': 'error',
-  'prefer-template': 'error',
-  'quote-props': ['error', 'as-needed', {
-    keywords: false,
-    numbers: true,
-    unnecessary: true
-  }],
-  quotes: ['error', 'single', {
-    allowTemplateLiterals: false,
-    avoidEscape: true
-  }],
-  radix: ['error', 'as-needed'],
-  'require-atomic-updates': 'error',
-  'require-await': 'off', // NOTE: See TypeScript rule extending this one
-  'require-unicode-regexp': 'error',
-  'require-yield': 'off',
-  'rest-spread-spacing': ['error', 'never'],
-  semi: ['error', 'always', {
-    omitLastInOneLineBlock: false
-  }],
-  'semi-spacing': ['error', {
-    after: true,
-    before: false
-  }],
-  'semi-style': ['error', 'last'],
-  'sort-imports': 'off',
-  'sort-keys': 'off',
-  'sort-vars': ['error', {
-    ignoreCase: true
-  }],
-  'space-before-blocks': ['error', 'always'],
-  'space-before-function-paren': ['error', {
-    anonymous: 'always',
-    asyncArrow: 'always',
-    named: 'never'
-  }],
-  'space-in-parens': ['error', 'never'],
-  'space-infix-ops': ['error', {
-    int32Hint: false
-  }],
-  'space-unary-ops': ['error', {
-    nonwords: false,
-    words: true
-  }],
-  'spaced-comment': ['error', 'always', {
-    block: {
-      balanced: true,
-      exceptions: ['-', '+', '*'],
-      markers: ['!', '*']
+export default [{
+  files: [
+    '**/*.ts',
+    '**/*.tsx',
+    '**/*.cts',
+    '**/*.mts',
+    '**/*.js',
+    '**/*.jsx',
+    '**/*.cjs',
+    '**/*.mjs'
+  ],
+  languageOptions: {
+    ecmaVersion: 'latest',
+    globals: {
+      ...globals.es2021
     },
-    line: {
-      exceptions: ['-', '+', '*'],
-      markers: ['!', '/', '=>']
-    }
-  }],
-  strict: ['error', 'never'],
-  'switch-colon-spacing': ['error', {
-    after: true,
-    before: false
-  }],
-  'symbol-description': 'error',
-  'template-curly-spacing': ['error', 'never'],
-  'template-tag-spacing': ['error', 'never'],
-  'unicode-bom': ['error', 'never'],
-  'use-isnan': ['error', {
-    enforceForIndexOf: true,
-    enforceForSwitchCase: true
-  }],
-  'valid-typeof': ['error', {
-    requireStringLiterals: false
-  }],
-  'vars-on-top': 'error',
-  'wrap-iife': ['error', 'inside', {
-    functionPrototypeMethods: true
-  }],
-  'wrap-regex': 'off',
-  'yield-star-spacing': ['error', 'both'],
-  yoda: ['error', 'never'],
-  ...rulesNo,
-  /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-  ...pluginTypescript.rules,
-  ...pluginPerfectionist.rules,
-  ...pluginImport.rules,
-  ...pluginSortKeysShorthand.rules
-  /* eslint-enable @typescript-eslint/no-unsafe-member-access */
-};
-
-export const settings = {
-  'import/resolver': {
-    typescript: {
-      project: './tsconfig.json'
+    parser: tseslint.parser,
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true
+      },
+      projectService: true
+    },
+    sourceType: 'module'
+  },
+  linterOptions: {
+    reportUnusedDisableDirectives: 'error'
+  },
+  name: '@ololoepepe/eslint-config-typescript',
+  plugins: {
+    perfectionist,
+    promise,
+    regexp,
+    unicorn,
+    '@eslint-community/eslint-comments': eslintComments,
+    '@stylistic': stylistic,
+    '@typescript-eslint': tseslint.plugin,
+    'import-x': importX,
+    'sort-keys-shorthand': sortKeysShorthand
+  },
+  rules: {
+    ...rulesCore,
+    ...rulesNo,
+    ...pluginEslintComments.rules,
+    ...pluginStylistic.rules,
+    ...pluginTypescript.rules,
+    ...pluginImportX.rules,
+    ...pluginPerfectionist.rules,
+    ...pluginPromise.rules,
+    ...pluginRegexp.rules,
+    ...pluginSortKeysShorthand.rules,
+    ...pluginUnicorn.rules
+  },
+  settings: {
+    'import-x/resolver': {
+      typescript: {
+        project: './tsconfig.json'
+      }
     }
   }
-};
+}];

package/src/node.js

@@ -0,0 +1,27 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access --
+   The ESLint plugin and globals registered in this wiring file are untyped
+   third-party modules, so the typed-linting rules treat them as `any`. Suppress
+   the unsafe-access reports for the whole file. */
+import n from 'eslint-plugin-n';
+import globals from 'globals';
+
+import base from '#src/index.js';
+import pluginN from '#src/plugins/n.js';
+
+export default [
+  ...base,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    },
+    name: '@ololoepepe/eslint-config-typescript/node',
+    plugins: {
+      n
+    },
+    rules: {
+      ...pluginN.rules
+    }
+  }
+];

package/src/plugins/eslint-comments.js

@@ -0,0 +1,16 @@
+export default {
+  rules: {
+    '@eslint-community/eslint-comments/disable-enable-pair': ['error', {
+      allowWholeFile: true
+    }],
+    '@eslint-community/eslint-comments/no-aggregating-enable': 'error',
+    '@eslint-community/eslint-comments/no-duplicate-disable': 'error',
+    '@eslint-community/eslint-comments/no-restricted-disable': 'off',
+    '@eslint-community/eslint-comments/no-unlimited-disable': 'error',
+    // NOTE: `no-unused-disable` is deprecated; `linterOptions.reportUnusedDisableDirectives`
+    // (set to 'error' in src/index.js) is the owner for unused disable directives.
+    '@eslint-community/eslint-comments/no-unused-enable': 'error',
+    '@eslint-community/eslint-comments/no-use': 'off',
+    '@eslint-community/eslint-comments/require-description': 'error'
+  }
+};

package/src/plugins/import-x.js

@@ -0,0 +1,107 @@
+export default {
+  rules: {
+    'import-x/consistent-type-specifier-style': 'off', // TODO: Reconsider if use TS/Flow
+    'import-x/default': 'error',
+    'import-x/dynamic-import-chunkname': ['error'],
+    'import-x/export': 'error',
+    'import-x/exports-last': 'off',
+    'import-x/extensions': 'off',
+    'import-x/first': ['error', 'absolute-first'],
+    'import-x/group-exports': 'off',
+    'import-x/max-dependencies': 'off',
+    'import-x/named': 'error',
+    'import-x/namespace': ['error', {
+      allowComputed: false
+    }],
+    'import-x/newline-after-import': ['error', {
+      considerComments: false,
+      count: 1
+    }],
+    'import-x/no-absolute-path': ['error', {
+      amd: true,
+      commonjs: true,
+      esmodule: true
+    }],
+    'import-x/no-amd': 'off',
+    'import-x/no-anonymous-default-export': 'off',
+    'import-x/no-commonjs': 'off',
+    'import-x/no-cycle': ['error', {
+      amd: true,
+      commonjs: true,
+      esmodule: true, // TODO
+      ignoreExternal: true
+    }],
+    'import-x/no-default-export': 'off',
+    'import-x/no-deprecated': 'warn',
+    'import-x/no-duplicates': ['error', {
+      considerQueryString: true
+    }],
+    'import-x/no-dynamic-require': 'off', // TODO
+    'import-x/no-empty-named-blocks': 'error',
+    'import-x/no-extraneous-dependencies': 'error',
+    'import-x/no-import-module-exports': 'off',
+    'import-x/no-internal-modules': 'off',
+    'import-x/no-mutable-exports': 'error',
+    'import-x/no-named-as-default': 'warn',
+    'import-x/no-named-as-default-member': 'error',
+    'import-x/no-named-default': 'off',
+    'import-x/no-named-export': 'off',
+    'import-x/no-namespace': 'off',
+    'import-x/no-nodejs-modules': 'off',
+    'import-x/no-relative-packages': 'off',
+    'import-x/no-relative-parent-imports': 'warn',
+    'import-x/no-restricted-paths': 'off',
+    'import-x/no-self-import': 'error',
+    'import-x/no-unassigned-import': 'off',
+    'import-x/no-unresolved': ['error', {
+      ignore: ['^#']
+    }],
+    'import-x/no-unused-modules': 'off', // TODO: Reconsider
+    'import-x/no-useless-path-segments': ['error', {
+      commonjs: true,
+      noUselessIndex: false
+    }],
+    'import-x/no-webpack-loader-syntax': 'error',
+    'import-x/order': ['error', {
+      alphabetize: {
+        caseInsensitive: true,
+        order: 'asc',
+        orderImportKind: 'ignore'
+      },
+      distinctGroup: true,
+      groups: ['builtin', 'external', 'type', 'internal', 'parent', 'sibling', 'index', 'object', 'unknown'],
+      'newlines-between': 'always-and-inside-groups',
+      pathGroups: [{
+        group: 'internal',
+        pattern: '#src/**'
+      }, {
+        group: 'parent',
+        pattern: '../**/styles.js',
+        position: 'after'
+      }, {
+        group: 'parent',
+        pattern: '../**/styles.css',
+        position: 'after'
+      }, {
+        group: 'parent',
+        pattern: '../**/styles.less',
+        position: 'after'
+      }, {
+        group: 'sibling',
+        pattern: './**/styles.js',
+        position: 'after'
+      }, {
+        group: 'sibling',
+        pattern: './**/styles.css',
+        position: 'after'
+      }, {
+        group: 'sibling',
+        pattern: './**/styles.less',
+        position: 'after'
+      }],
+      warnOnUnassignedImports: false
+    }],
+    'import-x/prefer-default-export': 'off',
+    'import-x/unambiguous': 'off' // TODO: Reconsider
+  }
+};

package/src/plugins/n.js

@@ -0,0 +1,48 @@
+export default {
+  rules: {
+    'n/callback-return': 'off',
+    'n/exports-style': 'off',
+    'n/file-extension-in-import': 'off', // Owned by import-x (import-x/extensions) — single owner for import paths.
+    'n/global-require': 'off',
+    'n/handle-callback-err': ['error', '^(err|error)$'],
+    'n/hashbang': 'error',
+    'n/no-callback-literal': 'error',
+    'n/no-deprecated-api': 'error',
+    'n/no-exports-assign': 'error',
+    'n/no-extraneous-import': 'off', // Owned by import-x/no-extraneous-dependencies.
+    'n/no-extraneous-require': 'off', // Owned by import-x/no-extraneous-dependencies.
+    'n/no-missing-import': 'off', // Owned by import-x/no-unresolved (+ TS resolver).
+    'n/no-missing-require': 'off', // Owned by import-x/no-unresolved (+ TS resolver).
+    'n/no-mixed-requires': 'off',
+    'n/no-new-require': 'error',
+    'n/no-path-concat': 'error',
+    'n/no-process-env': 'off',
+    'n/no-process-exit': 'warn',
+    'n/no-restricted-import': 'off',
+    'n/no-restricted-require': 'off',
+    'n/no-sync': 'off',
+    'n/no-top-level-await': 'off',
+    'n/no-unpublished-bin': 'error',
+    'n/no-unpublished-import': 'error',
+    'n/no-unpublished-require': 'error',
+    'n/no-unsupported-features/es-builtins': 'error',
+    // Downlevel syntax is owned by the TypeScript compiler (tsconfig `target`),
+    // not by static syntax inspection; this rule misfires on TS source and would
+    // need an `engines.node`/`version` baseline this package does not declare.
+    'n/no-unsupported-features/es-syntax': 'off',
+    'n/no-unsupported-features/node-builtins': 'error',
+    'n/prefer-global/buffer': 'error',
+    'n/prefer-global/console': 'error',
+    'n/prefer-global/crypto': 'error',
+    'n/prefer-global/process': 'error',
+    'n/prefer-global/text-decoder': 'error',
+    'n/prefer-global/text-encoder': 'error',
+    'n/prefer-global/timers': 'error',
+    'n/prefer-global/url': 'error',
+    'n/prefer-global/url-search-params': 'error',
+    'n/prefer-node-protocol': 'error',
+    'n/prefer-promises/dns': 'error',
+    'n/prefer-promises/fs': 'error',
+    'n/process-exit-as-throw': 'error'
+  }
+};

package/src/plugins/perfectionist.js

@@ -20,14 +20,20 @@ export default {
     'perfectionist/sort-exports': ['error', SORT_OPTIONS],
     'perfectionist/sort-heritage-clauses': ['error', SORT_OPTIONS],
     'perfectionist/sort-import-attributes': ['error', SORT_OPTIONS],
-    'perfectionist/sort-imports': ['error', SORT_OPTIONS],
+    // Import-statement ordering is owned by `import-x/order` (configured with
+    // project path groups); the two disagree on type-import placement and group
+    // spacing, so keep this off to avoid an unresolvable conflict. Named-specifier
+    // sorting (`sort-named-imports`) is a separate concern and stays on.
+    'perfectionist/sort-imports': 'off',
     'perfectionist/sort-interfaces': ['error', SORT_OPTIONS],
     'perfectionist/sort-intersection-types': ['error', SORT_OPTIONS],
     'perfectionist/sort-maps': ['error', SORT_OPTIONS],
     'perfectionist/sort-named-exports': ['error', SORT_OPTIONS],
     'perfectionist/sort-named-imports': ['error', SORT_OPTIONS],
     'perfectionist/sort-object-types': ['error', SORT_OPTIONS],
-    'perfectionist/sort-objects': ['error', SORT_OPTIONS],
+    // Object-literal key order is owned by `sort-keys-shorthand` (shorthand-first);
+    // keep this off to avoid a conflicting second sorter on the same concern.
+    'perfectionist/sort-objects': 'off',
     'perfectionist/sort-sets': ['error', SORT_OPTIONS],
     'perfectionist/sort-union-types': ['error', SORT_OPTIONS]
   }

package/src/plugins/promise.js

@@ -0,0 +1,25 @@
+export default {
+  rules: {
+    'promise/always-return': ['error', {
+      ignoreLastCallback: true
+    }],
+    'promise/avoid-new': 'off',
+    'promise/catch-or-return': 'error',
+    'promise/no-callback-in-promise': 'warn',
+    'promise/no-multiple-resolved': 'error',
+    'promise/no-native': 'off',
+    'promise/no-nesting': 'warn',
+    'promise/no-new-statics': 'error',
+    'promise/no-promise-in-callback': 'warn',
+    'promise/no-return-in-finally': 'error',
+    'promise/no-return-wrap': 'error',
+    'promise/param-names': 'error',
+    'promise/prefer-await-to-callbacks': 'off',
+    'promise/prefer-await-to-then': ['error', {
+      strict: true
+    }],
+    'promise/prefer-catch': 'error',
+    'promise/spec-only': 'error',
+    'promise/valid-params': 'error'
+  }
+};