.eslintrc.yml

root: true

env:
  es6: true

plugins:
  - import
  - prettier
  - security

extends:
  - eslint:recommended
  - plugin:import/recommended
  - plugin:prettier/recommended
  - plugin:security/recommended-legacy

parserOptions:
  ecmaVersion: 2020
  sourceType: module

overrides:
  - files:
      - '__tests__/**/*.js'
      - '*.spec.js'
      - '*.test.js'

    env:
      jest: true

  - files:
      - 'jest.config.js'

    env:
      node: true

    parserOptions:
      sourceType: commonjs

    rules:
      no-magic-numbers: off

  - files:
      - '*.ts'
      - '*.tsx'

    extends:
      - plugin:@typescript-eslint/recommended

    plugins:
      - '@typescript-eslint'

    parser: '@typescript-eslint/parser'

    rules:
      # The correct way to use with typescript-eslint is to disable the core version.
      # https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-use-before-define.md#how-to-use

      no-use-before-define: off
      '@typescript-eslint/no-use-before-define':
        - error

      no-unused-vars: off
      '@typescript-eslint/no-unused-vars':
        - error
        - argsIgnorePattern: ^_$
          varsIgnorePattern: ^_

      no-empty-function: off
      '@typescript-eslint/no-empty-function': error

      # TODO #4003: We will rework on these rules
      '@typescript-eslint/ban-ts-comment': off
      '@typescript-eslint/ban-types': off
      '@typescript-eslint/explicit-function-return-type': off
      '@typescript-eslint/explicit-member-accessibility': off
      '@typescript-eslint/explicit-module-boundary-types': off
      '@typescript-eslint/indent': off
      '@typescript-eslint/interface-name-prefix': off
      '@typescript-eslint/no-explicit-any': off

      no-duplicate-imports: off
      'import/no-duplicates': error

rules:
  # Only list rules that are not in *:recommended set
  # If rules are set to disable the one in *:recommended, please elaborate the reason

  accessor-pairs: error
  arrow-body-style:
    - error
    - as-needed
  arrow-parens:
    - error
    - as-needed
  arrow-spacing:
    - error
    - after: true
      before: true
  block-scoped-var: error
  class-methods-use-this:
    - error
    - exceptMethods:
        - render
  complexity: error
  curly: error
  default-case: error
  dot-notation: error
  eqeqeq: error
  max-classes-per-file:
    - error
    - 2
  no-alert: error
  no-async-promise-executor: error
  no-await-in-loop: error
  no-console:
    - error
    - allow:
        - error
        - warn
  no-caller: error
  no-div-regex: error
  no-duplicate-imports: error
  no-else-return: error
  no-empty-function: error
  no-eq-null: error
  no-eval: error
  no-extend-native: error
  no-extra-bind: error
  no-extra-label: error
  no-implicit-globals: error
  no-implied-eval: error
  no-invalid-this: error
  no-iterator: error
  no-label-var: error
  no-labels: error
  no-lone-blocks: error
  no-magic-numbers:
    - error
    - ignore:
        - 0
        - 1
  no-misleading-character-class: error
  no-multi-spaces:
    - error
    - ignoreEOLComments: true
  no-multi-str: error
  no-new-func: error
  no-new-wrappers: error
  no-new: error
  no-octal-escape: error
  no-proto: error
  no-return-assign: error
  no-return-await: error
  no-script-url: error
  no-self-compare: error
  no-sequences: error
  no-shadow-restricted-names: error
  no-template-curly-in-string: error
  no-throw-literal: error
  no-undef-init: error
  no-undefined: off
  no-unmodified-loop-condition: error
  no-unused-expressions:
    - error
    - allowShortCircuit: true
      allowTernary: true
  no-unused-vars:
    - error
    - argsIgnorePattern: ^_$
      varsIgnorePattern: ^_
  no-use-before-define: error
  no-useless-call: error
  no-useless-catch: error
  no-useless-computed-key: error
  no-useless-concat: error
  no-useless-constructor: error
  no-useless-rename: error
  no-useless-return: error
  no-var: error
  no-void: error
  no-with: error
  object-shorthand: error
  prefer-arrow-callback: error
  prefer-const: error
  prefer-destructuring: error
  prefer-promise-reject-errors: error
  prefer-rest-params: error
  prefer-spread: error
  radix: error
  require-atomic-updates: error
  require-await: error
  require-unicode-regexp: error
  rest-spread-spacing:
    - error
    - never
  template-curly-spacing:
    - error
    - never
  yield-star-spacing:
    - error
    - after
  yoda: error

  # Only identify *.js, does not work with *.ts
  'import/no-unresolved': off

  # We should review the rules below from time to time. Rules below are:
  # - From "recommended" ruleset but disabled for some reasons
  # - Rules that we considered to enable, but for some reasons, we did not enable them

  # Re-enable later
  # no-shadow:
  #   - error
  #   - builtinGlobals: true
  #     hoist: all

  # Cannot group global or local imports and sort in differently
  # sort-imports:
  #   - error
  #   - ignoreCase: true

  # Consider enable this rule while working on #4003
  # prefer-template: error

  # Conflict with "prettier/recommended"
  # Prettier: array.map(([name, value]) => name === value ? 'Yes' : 'No'
  # ESLint: array.map(([name, value]) => (name === value ? 'Yes' : 'No')
  # no-confusing-arrow:
  #   - error
  #   - allowParens: true # This will conflict with no-extra-parens

  # Conflicts with "prettier/recommended"
  # Prettier will format it before/after depends on usage.
  # Before: async *[Symbol.asyncIterator]() { ... }
  # After: function* name() { ... }

  # generator-star-spacing:
  #   - error
  #   - after

  # Conflicts with "prettier/recommended"
  # Prettier: (function () { ... })()
  # ESLint: (function () { ... }())

  # wrap-iife: error

  # Conflicts with "react/jsx-wrap-multilines"
  # no-extra-parens: error