.eslintrc.js

const ERROR = "error";
const WARN = "warn";
const OFF = "off";

const errorIfStrict = process.env.STRICT ? ERROR : WARN;

module.exports = {
  env: {
    browser: true,
    es6: true,
    node: true,
    jest: true,
  },
  parser: "@typescript-eslint/parser",
  parserOptions: {
    ecmaFeatures: {
      jsx: true,
    },
    ecmaVersion: "latest",
    sourceType: "module",
  },
  extends: [
    "eslint:recommended",
    "plugin:import/recommended",
    "airbnb",
    // Airbnb includes some helpful rules for ESLint and React that aren't covered by recommended.
    // See https://github.com/airbnb/javascript/tree/master/packages for specific rules.
    "plugin:jsdoc/recommended-typescript-error",
    "plugin:prettier/recommended", // Note: prettier must ALWAYS be the last extension.
  ],
  plugins: ["@typescript-eslint", "sort-destructure-keys", "check-file"],
  settings: {
    react: {
      version: "detect",
    },
    "import/resolver": {
      node: {
        paths: ["src"],
        extensions: [".js", ".jsx", ".ts", ".tsx"],
      },
    },
  },
  rules: {
    // Rules for ESLint.
    "arrow-body-style": [
      errorIfStrict,
      "as-needed",
      {
        requireReturnForObjectLiteral: false,
      },
    ],
    "consistent-return": OFF,
    curly: [errorIfStrict, "multi-line"],
    eqeqeq: [errorIfStrict, "always", { null: "ignore" }],
    "no-console": OFF,
    "no-debugger": errorIfStrict,
    "no-empty": [ERROR, { allowEmptyCatch: true }],
    "no-plusplus": [ERROR, { allowForLoopAfterthoughts: true }],
    "no-shadow": OFF,
    "no-undef": OFF,
    "no-unused-vars": OFF,
    "no-use-before-define": OFF,

    // Rules for typescript-eslint. Note that these rules extend the ESLint rules. This can cause conflicts, so the original
    // ESLint rules above must be disabled for the following rules to work.
    "@typescript-eslint/no-shadow": ERROR,
    "@typescript-eslint/no-unused-vars": [
      errorIfStrict,
      {
        vars: "all",
        args: "after-used",
        ignoreRestSiblings: true,
      },
    ],
    "@typescript-eslint/no-use-before-define": [
      ERROR,
      { functions: false, variables: false },
    ],

    // Rules for eslint-plugin-import. These describe rules about file imports.
    "import/extensions": [
      ERROR, // Allow imports without file extensions (airbnb rule)
      "ignorePackages",
      {
        js: "never",
        jsx: "never",
        ts: "never",
        tsx: "never",
      },
    ],
    "import/newline-after-import": WARN,
    "import/no-extraneous-dependencies": OFF,
    "import/no-unresolved": OFF,
    "import/prefer-default-export": OFF,

    // Rules for prettier.
    "prettier/prettier": errorIfStrict, // Makes Prettier issues warnings rather than errors.
    "sort-destructure-keys/sort-destructure-keys": errorIfStrict,
    "check-file/filename-naming-convention": [
      errorIfStrict,
      {
        // GraphQL fragments, mutations and queries
        "src/gql/fragments/**/*.graphql": "CAMEL_CASE",
        "src/gql/(mutations,queries)/**/*.graphql": "KEBAB_CASE",
        // Cypress
        "cypress/integration/**/*.ts": "SNAKE_CASE",
        // Scripts
        "scripts/**/*.{js,ts}": "KEBAB_CASE",
        // JS and TS with exceptions
        "src/(!test_utils)/**/!(vite-env.d)*.{js,ts}": "CAMEL_CASE",
        // All tsx with exceptions
        "src/!(test_utils)/**/!(use|getFormSchema|index|test-utils|schemaFields|getColumnsTemplate|githubPRLinkify|jiraLinkify)*.tsx":
          "PASCAL_CASE",
        // Test utils
        "src/test_utils/**/*": "KEBAB_CASE",
        // tsx exceptions
        "src/**/(use|getFormSchema|index)*.tsx": "CAMEL_CASE",
      },
      {
        ignoreMiddleExtensions: true,
      },
    ],
  },
  overrides: [
    // For React Typescript files in src.
    {
      files: ["src/**/*.ts", "src/**/*.tsx"],
      extends: ["plugin:react/recommended"],
      plugins: ["jsx-a11y", "react", "react-hooks", "@emotion"],
      rules: {
        // Rules for emotion.
        "@emotion/import-from-emotion": ERROR,
        "@emotion/no-vanilla": errorIfStrict,
        "@emotion/pkg-renaming": ERROR,
        "@emotion/syntax-preference": [errorIfStrict, "string"],

        // Rules for accessibility.
        "jsx-a11y/anchor-is-valid": errorIfStrict,
        "jsx-a11y/aria-props": errorIfStrict,
        "jsx-a11y/aria-role": [errorIfStrict, { ignoreNonDom: false }],
        "jsx-a11y/href-no-hash": OFF,
        "jsx-a11y/label-has-associated-control": [
          errorIfStrict,
          { some: ["nesting", "id"] },
        ],

        // Rules for import order.
        "import/order": [
          ERROR,
          {
            groups: ["external", "builtin", "internal"],
            pathGroups: [
              {
                pattern: "react",
                group: "external",
                position: "before",
              },
              {
                pattern: "@**",
                group: "external",
                position: "before",
              },
              {
                pattern:
                  "(analytics|components|constants|context|gql|hoc|hooks|pages|types|utils)/**",
                group: "internal",
                position: "before",
              },
            ],
            pathGroupsExcludedImportTypes: ["react"],
            alphabetize: {
              order: "asc",
              caseInsensitive: true,
            },
          },
        ],

        // Rules for React Hooks.
        "react-hooks/rules-of-hooks": ERROR, // Check rules of Hooks
        "react-hooks/exhaustive-deps": WARN, // Warn useMemo, useEffect dependencies

        // Rules for React.
        "react/destructuring-assignment": OFF, // Allow use of dot notation, for example user.id (airbnb rule)
        "react/display-name": OFF,
        "react/function-component-definition": [
          errorIfStrict,
          {
            namedComponents: "arrow-function", // Allow named components with arrow functions (airbnb rule)
          },
        ],
        "react/jsx-filename-extension": [1, { extensions: [".tsx"] }], // Allow JSX in TSX file (airbnb rule)
        "react/jsx-props-no-spreading": [
          errorIfStrict,
          {
            custom: "ignore",
            explicitSpread: "ignore",
          },
        ],
        "react/prop-types": OFF, // (airbnb rule)
        "react/react-in-jsx-scope": OFF, // Disable because there is no need to import React in React 17+ (airbnb rule)
        "react/require-default-props": OFF, // Allow not setting defaults for props (airbnb rule)
        "react/sort-comp": [
          errorIfStrict,
          { order: ["everything-else", "render"] },
        ],
        "react/no-unstable-nested-components": OFF, // This rule should be removed as part of EVG-17265.
      },
      parserOptions: {
        project: ["./tsconfig.json"],
      },
    },
    // For Jest files.
    {
      files: ["src/**/*.test.ts", "src/**/*.test.tsx"],
      extends: ["plugin:testing-library/react", "plugin:jest/all"],
      rules: {
        "@typescript-eslint/unbound-method": OFF,
        "jest/max-expects": [
          WARN,
          {
            max: 10,
          },
        ],
        "jest/no-hooks": OFF,
        "jest/no-mocks-import": OFF,
        "jest/prefer-expect-assertions": OFF,
        "jest/unbound-method": OFF,
      },
    },
    // For Storybook files.
    {
      files: ["src/**/*.stories.@(ts|tsx|js|jsx|mjs|cjs)"],
      extends: ["plugin:storybook/recommended"],
      rules: {
        "storybook/story-exports": ERROR,
        "storybook/no-stories-of": ERROR,
        "storybook/no-redundant-story-name": WARN,
        "storybook/csf-component": WARN, // Enables support for auto generated prop controls and documentation
      },
    },
    // For Cypress files.
    {
      files: ["cypress/**/*.ts"],
      extends: ["plugin:cypress/recommended"],
      parserOptions: {
        project: "cypress/tsconfig.json",
      },
      rules: {
        "cypress/unsafe-to-chain-command": WARN,
      },
    },
    // For GraphQL files.
    {
      files: ["src/gql/**/*.graphql"],
      extends: "plugin:@graphql-eslint/operations-recommended",
      rules: {
        "@graphql-eslint/selection-set-depth": OFF,
        "@graphql-eslint/no-deprecated": WARN,
        "@graphql-eslint/alphabetize": [
          ERROR,
          { selections: ["OperationDefinition", "FragmentDefinition"] },
        ],
        // Allows importing fragments without lint errors.
        "spaced-comment": OFF,
        "@typescript-eslint/spaced-comment": OFF,
      },
    },
  ],
};