.eslintrc.js

module.exports = {
  plugins: [
    '@typescript-eslint',
    'react',
    'react-hooks',
    'jest',
    'jsx-a11y',
    '@eslint-react/eslint-plugin',
  ],
  extends: [
    'eslint:recommended',
    'plugin:react/recommended', // Uses the recommended rules from @eslint-plugin-react
    'plugin:react-hooks/recommended',
    'prettier', // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
    'plugin:prettier/recommended', // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
    'plugin:jsx-a11y/recommended',
  ],
  overrides: [
    {
      extends: [
        'plugin:jsdoc/recommended',
        // Functional rule configurations, for best best practices and code correctness
        'plugin:@typescript-eslint/recommended',
        // Stylistic rule configurations, for consistent and predictable syntax usage
        'plugin:@typescript-eslint/stylistic-type-checked',
        // Eslint React plugin
        'plugin:@eslint-react/recommended-legacy',
      ],
      files: ['**/*.{ts,tsx}'],
      parserOptions: {
        tsconfigRootDir: __dirname,
        project: ['./tsconfig.json'],
      },
      rules: {
        '@typescript-eslint/explicit-function-return-type': 'off',
        '@typescript-eslint/no-unused-vars': 'warn',
        '@typescript-eslint/no-explicit-any': 'warn',
        '@typescript-eslint/prefer-optional-chain': 'warn',
        '@typescript-eslint/prefer-as-const': 'error',
        '@typescript-eslint/await-thenable': 'error',
        '@typescript-eslint/no-var-requires': 'off',
        '@typescript-eslint/no-unnecessary-type-assertion': 'error',

        '@typescript-eslint/default-param-last': 'error',
        '@typescript-eslint/prefer-for-of': 'warn',
        '@typescript-eslint/prefer-includes': 'error',
        '@typescript-eslint/prefer-string-starts-ends-with': 'error',
        '@typescript-eslint/switch-exhaustiveness-check': 'error',

        // causes a build error and has a lot of effects on components
        '@typescript-eslint/prefer-nullish-coalescing': 'off',

        // better readability by naming keys
        '@typescript-eslint/consistent-indexed-object-style': 'off',

        // JSDOC extends overrides: disable some of extends rules
        // JSdoc is not always needed
        'jsdoc/require-jsdoc': 0,
        // Prefer declaring types with typescript
        'jsdoc/require-returns': 0,
        'jsdoc/require-returns-type': 0,
        'jsdoc/require-param': 0,
        'jsdoc/require-param-type': 0,

        // Allow some params to be described and some to be omitted
        'jsdoc/check-param-names': 0,

        // a11y label fix, nesting is enough
        'jsx-a11y/label-has-associated-control': 0,

        // Note: you must disable the base rule as it can report incorrect errors
        'require-await': 'off',
        '@typescript-eslint/require-await': 'error',

        // disable recommandations
        '@eslint-react/hooks-extra/no-redundant-custom-hook': 0, // great rule but should not be run in tests files
        '@eslint-react/hooks-extra/no-direct-set-state-in-use-effect': 0, // to enable in another MR will have a lot of impact
        '@eslint-react/dom/no-dangerously-set-innerhtml': 0, // used for for injecting html tags
        '@eslint-react/no-array-index-key': 0,
        '@eslint-react/no-unused-class-component-members': 0, // disabled for ".d.ts" files
        '@eslint-react/no-leaked-conditional-rendering': 'error', // important ! avoids rendering 0
      },
    },
    {
      files: ['**/*.spec.{ts,tsx}'],
      extends: ['plugin:jest/recommended', 'plugin:testing-library/react'],
      rules: {
        'jest/no-mocks-import': 0,

        // For testing View components which renders other components -> implementation tests ?
        'testing-library/no-container': 0,

        // Allows checking classes on containers -> could be fixed
        'testing-library/no-node-access': 0,
      },
    },
  ],
  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
  parserOptions: {
    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
    sourceType: 'module', // Allows for the use of imports
    ecmaFeatures: {
      jsx: true, // Allows for the parsing of JSX
    },
  },
  rules: {
    // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
    // Note: you must disable the base rule as it can report incorrect errors
    'no-unused-vars': 'off',
    'no-case-declarations': 'warn',
    camelcase: 'warn',
    'react/prop-types': 'warn',
    'no-console': 'off',
    'no-param-reassign': 'warn',
    'spaced-comment': ['error', 'always', { block: { exceptions: ['*'] } }],
    'react/self-closing-comp': 'warn',
    'react/jsx-curly-brace-presence': ['error'],
    'react/jsx-no-useless-fragment': ['error'],

    // Rule to suggest using useAppDispatch instead of regular useDispatch
    'no-restricted-imports': 'off',
    '@typescript-eslint/no-restricted-imports': [
      'warn',
      {
        name: 'react-redux',
        importNames: ['useSelector', 'useDispatch'],
        message:
          'Use typed hooks `useAppDispatch` and `useAppSelector` instead.',
      },
    ],
  },
  root: true,
  settings: {
    react: {
      version: 'detect', // Tells eslint-plugin-react to automatically detect the version of React to use
    },
  },
  env: {
    browser: true,
    node: true,
  },
}