.eslintrc.js

const { nxModuleBoundaryRules } = require('./.eslintrc.module-boundaries');
const { namingConventionConfig } = require('./.eslintrc.naming-convention');
const { join } = require('path');

/**
 * Roadmap typescript-eslint
 * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/ROADMAP.md
 *
 * ESLint Rules: https://eslint.org/docs/rules/
 */
module.exports = {
  root: true,
  extends: ['eslint:recommended', 'prettier'],
  plugins: [
    'prettier',
    '@nx/eslint-plugin',
    '@stylistic',
    'unicorn', // https://www.npmjs.com/package/eslint-plugin-unicorn
  ],

  ignorePatterns: ['*.min.js', 'node_modules/'],
  settings: {
    polyfills: ['fetch', 'Promise'],
  },
  rules: {
    'eslint-comments/no-unused-disable': 'error',
    'eslint-comments/no-use': [
      'error',
      {
        allow: ['eslint-disable-next-line'],
      },
    ],
    'eslint-comments/disable-enable-pair': [
      'error',
      {
        allowWholeFile: false,
      },
    ],
    'eslint-comments/require-description': [
      'error',
      {
        ignore: [],
      },
    ],
    'eslint-comments/no-restricted-disable': ['error', '*', '!no-console', '!prettier'],
    'arrow-parens': ['error', 'as-needed'],
    'brace-style': 'off', // handled by @typescript-eslint rule
    'compat/compat': 'error',
    'comma-spacing': 'off', // handled by @typescript-eslint rule
    'constructor-super': 'error',
    complexity: ['error', 10],
    'default-param-last': 'off', // handled by @typescript-eslint rule
    eqeqeq: 'error',
    'func-name-matching': ['error', 'always'],
    'guard-for-in': 'error',
    'lines-between-class-members': 'off',
    'max-depth': ['error', 4],
    'max-len': [
      'error',
      {
        code: 140,
        comments: 140,
        ignoreStrings: true,
        ignorePattern: '// eslint-disable',
        ignoreComments: true,
        ignoreTrailingComments: true,
        ignoreUrls: true,
        ignoreTemplateLiterals: true,
        ignoreRegExpLiterals: true,
      },
    ],
    'max-lines': [
      'error',
      {
        max: 600,
        skipBlankLines: true,
      },
    ],
    'max-lines-per-function': [
      'error',
      {
        max: 45,
        skipBlankLines: true,
        skipComments: true,
      },
    ],
    'max-nested-callbacks': ['error', 4],
    'max-params': ['error', 12],
    'no-alert': 'error',
    'no-await-in-loop': 'error',
    'no-bitwise': 'error',
    'no-dupe-class-members': 'error',
    'no-caller': 'error',
    'no-confusing-arrow': 'error',
    'no-console': 'error',
    'no-constructor-return': 'error',
    'no-continue': 'error',
    'no-debugger': 'error',
    'no-duplicate-case': 'error',
    'no-duplicate-imports': 'error',
    'no-else-return': 'error',
    'no-empty': 'error',
    'no-empty-function': 'off', // handled by typescript-eslint rule
    'no-fallthrough': 'error',
    'no-eval': 'error',
    'no-extend-native': 'error',
    'no-extra-parens': 'off', // handled by prettier
    'no-extra-boolean-cast': 'off', // conflicts with strict boolean expressions
    'no-floating-decimal': 'error',
    'no-implicit-coercion': 'error',
    'no-invalid-this': 'off', // keep off
    'no-labels': [
      'error',
      {
        allowSwitch: true,
      },
    ],
    'no-lone-blocks': 'error',
    'no-lonely-if': 'error',
    'no-loop-func': 'error',
    'no-magic-numbers': 'off', // handled by typescript-eslint rule
    'no-new-wrappers': 'error',
    'no-param-reassign': 'error',
    'no-plusplus': 'error',
    'no-restricted-imports': ['error', 'rxjs/Rx'],
    'no-return-assign': 'error',
    'no-return-await': 'error',
    'no-self-compare': 'error',
    'no-sequences': 'error',
    'no-shadow': 'off', // handled by typescript-eslint rule
    'no-shadow-restricted-names': 'error',
    'no-template-curly-in-string': 'error',
    'no-throw-literal': 'off', // handled by typescript-eslint rule
    'no-undefined': 'error',
    'no-unmodified-loop-condition': 'error',
    'no-unreachable': 'error',
    'no-unsafe-finally': 'error',
    'no-unused-expressions': [
      'error',
      {
        allowShortCircuit: true,
        allowTernary: true,
      },
    ],
    'no-unused-labels': 'error',
    'no-useless-catch': 'error',
    'no-useless-concat': 'error',
    'no-useless-return': 'error',
    'prefer-const': 'error',
    'prefer-object-spread': 'error',
    'prefer-spread': 'error',
    'prefer-promise-reject-errors': 'error',
    'prettier/prettier': 'error',
    quotes: 'off', // handled by typescript eslint rule
    'simple-import-sort/imports': 'error',
    'simple-import-sort/exports': 'error',
    'sort-imports': 'off', // handled by simple-import-sort/sort
    radix: 'error',
    'require-atomic-updates': 'error',
    'require-await': 'off', // handled by typescript-eslint rule
    'require-jsdoc': [
      'off', // TODO: turn on
      {
        require: {
          FunctionDeclaration: false,
          MethodDefinition: false,
          ClassDeclaration: true,
          ArrowFunctionExpression: false,
        },
      },
    ],
    yoda: ['error', 'never'],
    'unicorn/filename-case': 'error',
  },
  overrides: [
    {
      files: '*.json',
      parser: 'jsonc-eslint-parser',
      rules: {},
    },
    {
      files: ['**/*.js'],
      env: {
        browser: true,
        node: true,
      },
      parserOptions: {
        ecmaVersion: 'latest',
        sourceType: 'module',
        createDefaultProgram: true,
      },
      extends: ['eslint:recommended', 'plugin:prettier/recommended', 'plugin:eslint-comments/recommended'],
      plugins: [
        'prettier',
        'simple-import-sort', // https://github.com/lydell/eslint-plugin-simple-import-sort
        'eslint-comments', // https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/
        'unicorn', // https://www.npmjs.com/package/eslint-plugin-unicorn
      ],
    },
    {
      files: ['**/.eslintrc.naming-convention.js'],
      rules: {
        'max-lines-per-function': [
          'error',
          {
            max: 100,
            skipBlankLines: true,
            skipComments: true,
          },
        ],
      },
    },
    {
      files: '**/*.ts',
      parser: '@typescript-eslint/parser',
      parserOptions: {
        ecmaVersion: 2020,
        sourceType: 'module',
        project: [join(__dirname, './tsconfig.base.json')],
        createDefaultProgram: true,
      },
      extends: [
        'eslint:recommended',
        'plugin:@typescript-eslint/eslint-recommended',
        'plugin:@typescript-eslint/recommended',
        'prettier',
        'plugin:eslint-comments/recommended',
        'plugin:no-unsanitized/recommended-legacy',
      ],
      plugins: [
        'prettier',
        '@typescript-eslint', // https://github.com/typescript-eslint/typescript-eslint
        '@angular-eslint', // https://github.com/angular-eslint/angular-eslint
        'simple-import-sort', // https://github.com/lydell/eslint-plugin-simple-import-sort
        'rxjs', // https://github.com/cartant/eslint-plugin-rxjs
        'compat', // https://www.npmjs.com/package/eslint-plugin-compat
        'eslint-comments', // https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/
        'unicorn', // https://www.npmjs.com/package/eslint-plugin-unicorn
        '@nx/eslint-plugin',
      ],
      rules: {
        '@nx/enforce-module-boundaries': ['error', nxModuleBoundaryRules],
        '@stylistic/brace-style': 'error',
        '@stylistic/comma-spacing': ['error', { before: false, after: true }],
        '@stylistic/lines-between-class-members': ['error', 'always', { exceptAfterOverload: true }],
        '@stylistic/quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: true }],
        '@typescript-eslint/adjacent-overload-signatures': 'error',
        '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
        '@typescript-eslint/await-thenable': 'error',
        '@typescript-eslint/ban-ts-comment': 'error',
        '@typescript-eslint/ban-tslint-comment': 'error',
        '@typescript-eslint/consistent-generic-constructors': 'error',
        '@typescript-eslint/consistent-type-assertions': 'error',
        '@typescript-eslint/consistent-type-definitions': 'error',
        '@typescript-eslint/consistent-type-exports': 'error',
        '@typescript-eslint/consistent-type-imports': 'error',
        '@typescript-eslint/no-deprecated': 'error',
        '@typescript-eslint/no-restricted-types': [
          'error',
          {
            types: {
              Object: 'Avoid using the `Object` type. Did you mean `object`?',
              Boolean: 'Avoid using the `Boolean` type. Did you mean `boolean`?',
              Number: 'Avoid using the `Number` type. Did you mean `number`?',
              String: 'Avoid using the `String` type. Did you mean `string`?',
              Symbol: 'Avoid using the `Symbol` type. Did you mean `symbol`?',
            },
          },
        ],
        '@typescript-eslint/default-param-last': ['error'],
        '@typescript-eslint/explicit-function-return-type': 'off', // keep off
        '@typescript-eslint/explicit-module-boundary-types': 'off', // keep off
        '@typescript-eslint/explicit-member-accessibility': [
          'error',
          {
            ignoredMethodNames: ['constructor'],
          },
        ],
        '@typescript-eslint/member-ordering': [
          'error',
          {
            default: ['static-field', 'instance-field', 'static-method', 'instance-method'],
          },
        ],
        ...namingConventionConfig(),
        '@typescript-eslint/no-dynamic-delete': 'error',
        '@typescript-eslint/no-empty-function': [
          'error',
          {
            allow: ['constructors'],
          },
        ],
        '@typescript-eslint/no-empty-interface': 'error',
        '@typescript-eslint/no-extraneous-class': [
          'error',
          {
            allowEmpty: true,
            allowStaticOnly: true,
            allowWithDecorator: true,
          },
        ],
        '@typescript-eslint/no-floating-promises': [
          'error',
          {
            ignoreVoid: true, // setting to false leads to messy code where it's reasonable to use void
          },
        ],

        '@typescript-eslint/no-inferrable-types': 'error',
        '@typescript-eslint/no-magic-numbers': [
          'error',
          {
            ignoreNumericLiteralTypes: true,
            ignoreReadonlyClassProperties: true,
            ignore: [-1, 0, 1], // ignore -1, binary
            ignoreEnums: true, // ignore enumerators so that numeric values can be grouped via enums instead of constants,
          },
        ],

        '@typescript-eslint/no-misused-new': 'error',
        '@typescript-eslint/no-misused-promises': [
          'error',
          {
            checksVoidReturn: false,
            checksConditionals: true,
          },
        ],
        '@typescript-eslint/no-non-null-assertion': 'error',
        '@typescript-eslint/no-for-in-array': 'error',
        '@typescript-eslint/no-shadow': 'error',
        '@typescript-eslint/no-this-alias': 'error',
        '@typescript-eslint/no-unnecessary-type-arguments': 'error',
        '@typescript-eslint/no-unnecessary-type-assertion': [
          'error',
          {
            typesToIgnore: [''],
          },
        ],
        '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
        '@typescript-eslint/no-unsafe-member-access': 'error',
        '@typescript-eslint/no-unused-vars': [
          'error',
          {
            vars: 'all',
            args: 'none',
            ignoreRestSiblings: false,
          },
        ],
        '@typescript-eslint/no-require-imports': 'error',
        '@typescript-eslint/no-use-before-define': [
          'error',
          {
            functions: false,
            classes: false, // decorator options become unusable if set to true
          },
        ],

        '@typescript-eslint/no-explicit-any': [
          'error',
          {
            ignoreRestArgs: true,
          },
        ],
        '@typescript-eslint/no-var-requires': 'error',
        '@typescript-eslint/prefer-function-type': 'error',
        '@typescript-eslint/prefer-readonly': ['error'],
        '@typescript-eslint/prefer-includes': 'error',
        '@typescript-eslint/prefer-readonly-parameter-types': [
          'off', // TODO: revise if this can be turned on, this rule seems to have buggy behavior
          {
            checkParameterProperties: false,
          },
        ],
        '@typescript-eslint/prefer-optional-chain': 'error',
        '@typescript-eslint/prefer-nullish-coalescing': [
          'error',
          {
            ignoreConditionalTests: true,
            ignoreMixedLogicalExpressions: true,
          },
        ],
        '@typescript-eslint/promise-function-async': 'off', // keep off
        '@typescript-eslint/require-await': 'off', // keep off
        '@typescript-eslint/restrict-plus-operands': 'error',
        '@typescript-eslint/strict-boolean-expressions': 'error',
        '@typescript-eslint/triple-slash-reference': [
          'error',
          {
            path: 'never',
            types: 'never',
            lib: 'never',
          },
        ],
        '@typescript-eslint/unbound-method': [
          'off', // keep of for now
          {
            ignoreStatic: true,
          },
        ],
        'rxjs/ban-observables': 'off', // keep off
        'rxjs/ban-operators': 'off', // keep off
        'rxjs/no-async-subscribe': 'error',
        'rxjs/no-compat': 'error',
        'rxjs/no-create': 'error',
        'rxjs/no-ignored-error': 'off', // keep of for now; turn it on later maybe
        'rxjs/no-ignored-observable': 'error',
        'rxjs/no-ignored-subscribe': 'off', // keep off
        'rxjs/no-ignored-subscription': 'error',
        'rxjs/no-internal': 'error',
        'rxjs/no-nested-subscribe': 'error',
        'rxjs/no-subclass': 'error',
        'rxjs/throw-error': 'error',
        'rxjs/no-tap': 'off', // keep off
        'rxjs/no-exposed-subjects': 'error',
        'rxjs/no-subject-unsubscribe': 'error',
        'rxjs/suffix-subjects': [
          'error',
          {
            parameters: true,
            properties: true,
            suffix: 'Subject',
            types: {
              '^EventEmitter$': false,
            },
            variables: true,
          },
        ],
        'rxjs/no-topromise': 'error',
        'rxjs/no-redundant-notify': 'error',
        'rxjs/no-unsafe-catch': 'error',
        'rxjs/no-unsafe-subject-next': 'error',
        'rxjs/no-unsafe-switchmap': 'error',
        'rxjs/no-unsafe-takeuntil': 'error',
        'rxjs/no-unbound-methods': 'error',
      },
    },
    {
      files: '**/test-setup.ts',
      rules: {
        'simple-import-sort/imports': 'off',
        'simple-import-sort/exports': 'off',
      },
    },
    {
      files: ['**/main.ts', '*logger*.ts', '**/http-handlers.service.ts'],
      rules: {
        'no-console': 'off',
      },
    },
    {
      files: '**/polyfills.ts',
      rules: {
        '@typescript-eslint/no-unsafe-member-access': 'off',
        '@typescript-eslint/no-explicit-any': 'off',
      },
    },
    {
      files: '**/polyfills/**',
      rules: {
        '@typescript-eslint/no-unsafe-member-access': 'off',
        '@typescript-eslint/no-explicit-any': 'off',
        'no-extend-native': 'off',
        'no-bitwise': 'off',
      },
    },
    {
      files: '**/*.patch.ts',
      rules: {
        'compat/compat': 'off',
      },
    },
    {
      files: ['**/*.mock.ts'],
      rules: {
        'compat/compat': 'off',
        'rxjs/no-exposed-subjects': 'off',
      },
    },
    {
      files: '**/*.spec.ts',
      rules: {
        'max-depth': ['error', 5],
        'max-lines-per-function': 'off',
        'compat/compat': 'off',
        '@typescript-eslint/no-explicit-any': 'off',
        '@typescript-eslint/no-unsafe-member-access': 'off',
        'rxjs/no-exposed-subjects': 'off',
      },
    },
    {
      // generated graphql and protobuf definitions
      files: ['**/generated/**', '**/grpc/**', '*proto*.*'],
      rules: {
        'max-lines': 'off',
        'no-dupe-class-members': 'off',
        '@typescript-eslint/explicit-member-accessibility': 'off',
        '@typescript-eslint/member-ordering': 'off',
        '@typescript-eslint/no-explicit-any': 'off',
        '@typescript-eslint/no-unused-vars': 'off',
        '@typescript-eslint/naming-convention': 'off',
        'simple-import-sort/imports': 'off',
        'simple-import-sort/exports': 'off',
      },
    },
    {
      // jest configs may be converted from js to ts, but it still has to use some js language features
      files: ['apollo.mock.ts'],
      rules: {
        ...namingConventionConfig({ testSetup: true }),
      },
    },
    {
      // jest configs may be converted from js to ts, but it still has to use some js language features
      files: ['**/jest.config.ts', '**/jest.preset.ts'],
      rules: {
        '@typescript-eslint/no-require-imports': 'off',
        '@typescript-eslint/no-var-requires': 'off',
        '@typescript-eslint/no-unsafe-member-access': 'off',
        ...namingConventionConfig({ jestConfigs: true }),
      },
    },
  ],
};