.eslintrc.js

'use strict'

module.exports = {
  parser: '@typescript-eslint/parser',
  parserOptions: {
    ecmaFeatures: {
      jsx: true,
    },
  },
  extends: [
    'plugin:react/recommended',
    'plugin:jsx-a11y/recommended',
    'plugin:react-hooks/recommended',
    'plugin:prettier/recommended',
    'plugin:github/recommended',
    'plugin:github/browser',
    'plugin:primer-react/recommended',
    'plugin:import/typescript',
    'plugin:ssr-friendly/recommended',
  ],
  settings: {
    react: {
      version: 'detect',
    },
    'import/parsers': {
      '@typescript-eslint/parser': ['.js', '.jsx', '.ts', '.tsx'],
      'eslint-mdx': ['.mdx'],
    },
    'import/resolver': {
      node: true,
      typescript: true,
    },
  },
  ignorePatterns: [
    'node_modules',
    '.cache',
    'coverage/**/*',
    'docs/public/**/*',
    'dist/**/*',
    'lib/**/*',
    'lib-*/**/*',
    'types/**/*',
    'consumer-test/**/*',
    'contributor-docs/adrs/*',
    'examples/codesandbox/**',
    // Note: this file is inlined from an external dependency
    'packages/react/src/utils/polymorphic.ts',
    'storybook-static',
    'CHANGELOG.md',
  ],
  globals: {
    __DEV__: 'readonly',
  },
  env: {
    browser: true,
    commonjs: true,
    es6: true,
    jest: true,
    node: true,
  },
  // rules which apply to JS, TS, etc.
  rules: {
    'no-shadow': 'off',
    'react/button-has-type': 'error',
    'react/prop-types': 'off',
    'react/display-name': 'off',
    'react-hooks/exhaustive-deps': 'error',
    camelcase: [
      'error',
      {
        allow: [
          'dark_dimmed',
          // Allow feature flag names that start with `primer_react_`
          '^primer_react_',
        ],
      },
    ],

    // Overrides from updating plugin:github
    'filenames/match-regex': 'off',
    'import/extensions': 'off',
    'import/namespace': 'off',
    'import/no-commonjs': 'off',
    'import/no-nodejs-modules': 'off',
    'import/no-dynamic-require': 'off',
    'import/no-unresolved': 'off',
    'i18n-text/no-en': 'off',
    'github/no-inner-html': 'off',
    'github/role-supports-aria-props': 'off',
    'no-restricted-syntax': 'off',
    'primer-react/a11y-use-next-tooltip': 'off',
  },
  overrides: [
    // rules which apply only to JS
    {
      files: ['**/*.{js,jsx}'],
      rules: {
        'eslint-comments/no-use': 'off',
        'import/no-namespace': 'off',
        'import/no-named-as-default': 'off',
        'import/no-named-as-default-member': 'off',
        'primer-react/direct-slot-children': ['error', {skipImportCheck: true}],
        'no-unused-vars': [
          'error',
          {
            ignoreRestSiblings: true,
          },
        ],
      },
    },

    // rules which apply only to TS
    {
      parserOptions: {
        project: ['./tsconfig.json', './packages/**/tsconfig.json', './examples/**/tsconfig.json'],
      },
      files: ['**/*.{ts,tsx}'],
      extends: ['plugin:@typescript-eslint/recommended'],
      rules: {
        '@typescript-eslint/consistent-type-imports': 'error',
        '@typescript-eslint/no-explicit-any': 'error',
        '@typescript-eslint/no-unnecessary-condition': 'error',
        '@typescript-eslint/explicit-module-boundary-types': 'off',
        '@typescript-eslint/no-unused-vars': [
          'error',
          {
            argsIgnorePattern: '^_',
          },
        ],
        '@typescript-eslint/no-shadow': 'off',
        '@typescript-eslint/no-empty-function': 'off',
        '@typescript-eslint/ban-ts-comment': [
          'error',
          {
            'ts-ignore': 'allow-with-description',
          },
        ],
        'import/default': 'off',
        'import/no-deprecated': 'off',
        'import/no-named-as-default': 'off',
        'import/no-named-as-default-member': 'off',
        'primer-react/direct-slot-children': ['error', {skipImportCheck: true}],
        'no-restricted-imports': [
          'error',
          {
            paths: [
              {
                name: 'react',
                importNames: ['useLayoutEffect'],
                message:
                  'Please use the `useIsomorphicLayoutEffect` hook from `src/hooks/useIsomorphicLayoutEffect.ts` instead',
              },
              {
                name: 'clsx',
                importNames: ['default'],
                message: 'Use the named import instead: `import {clsx} from "clsx"`',
              },
            ],
            patterns: [
              {
                group: ['**/utils/ssr'],
                importNames: ['useSSRSafeId'],
                message: 'Please use the `useId` hook from `src/hooks/useId.ts` instead',
              },
            ],
          },
        ],
      },
    },

    // Tests
    {
      files: ['**/*.test.{ts,tsx}'],
      extends: ['plugin:jest/recommended', 'plugin:testing-library/react'],
      rules: {
        '@typescript-eslint/no-non-null-assertion': 'off',
        'jest/expect-expect': 'off',
        'jest/no-conditional-expect': 'off',
        'jest/no-disabled-tests': 'off',
        'testing-library/prefer-screen-queries': 'off',
        'testing-library/no-node-access': 'off',
        'testing-library/no-container': 'off',
        'testing-library/render-result-naming-convention': 'off',
        'testing-library/prefer-presence-queries': 'off',
        'testing-library/prefer-find-by': 'off',
        'testing-library/no-wait-for-multiple-assertions': 'off',
      },
    },

    // Stories
    {
      files: ['**/*.stories.{ts,tsx}'],
      extends: ['plugin:storybook/recommended'],
      rules: {},
    },

    // e2e tests
    {
      files: ['playwright.config.ts', 'e2e/**/*.{ts,tsx}'],
      parserOptions: {
        project: 'tsconfig.json',
      },
      extends: ['plugin:playwright/recommended'],
      rules: {
        'playwright/expect-expect': 'off',
        'playwright/no-conditional-expect': 'off',
        'playwright/no-conditional-in-test': 'off',
        'playwright/no-wait-for-selector': 'off',
        'playwright/valid-title': 'off',
      },
    },

    // rules which apply only to Markdown
    {
      files: ['**/*.{md,mdx}'],
      extends: ['plugin:mdx/recommended'],
      settings: {
        'mdx/code-blocks': true,
      },
      rules: {
        'no-unused-vars': 'off',
        'prettier/prettier': 'off',
        'react/jsx-no-undef': 'off',
        'react/no-unescaped-entities': 'off',
        'primer-react/direct-slot-children': 'off',
      },
    },

    // rules which apply only to Markdown code blocks
    {
      files: ['**/*.{md,mdx}/**'],
      parserOptions: {
        project: false,
      },
      rules: {
        camelcase: 'off',
        'no-constant-condition': 'off',
        'no-console': 'off',
        'no-empty-pattern': 'off',
        'no-unused-vars': 'off',
        'no-undef': 'off',
        'react/no-unescaped-entities': 'off',
        'react/react-in-jsx-scope': 'off',
        'react/jsx-no-undef': 'off',
        'react/jsx-key': 'off',
        'react/jsx-no-comment-textnodes': 'off',
        'react-hooks/rules-of-hooks': 'off',
        'import/no-anonymous-default-export': 'off',
        'prettier/prettier': 'off',
        // These a11y rules should eventually be re-enabled
        'jsx-a11y/anchor-is-valid': 'off',
        'jsx-a11y/accessible-emoji': 'off',
        'jsx-a11y/label-has-for': 'off',
        '@typescript-eslint/no-unnecessary-condition': 'off',
        '@typescript-eslint/no-unused-vars': 'off',
        'no-redeclare': 'off',
        'ssr-friendly/no-dom-globals-in-module-scope': 'off',
        'ssr-friendly/no-dom-globals-in-react-fc': 'off',
      },
    },
  ],
}