.eslintrc.json

{
  "root": true,
  "parser": "@typescript-eslint/parser",
  "plugins": [
    "@typescript-eslint",
    "prettier",
    "unicorn",
    "import",
    "simple-import-sort",
    "sort-class-members",
    "vitest"
  ],
  "extends": [
    "eslint:recommended",
    "plugin:react/recommended", // Uses the recommended rules from @eslint-plugin-react
    "plugin:@typescript-eslint/recommended", // Uses the recommended rules from the @typescript-eslint/eslint-plugin
    "plugin:import/recommended",
    "plugin:import/typescript",
    "prettier" // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
  ],
  "settings": {
    "react": {
      "version": "detect"
    }
  },
  "rules": {
    "no-alert": "error",
    "sort-class-members/sort-class-members": [
      "error",
      {
        "order": [
          "[static-properties]",
          "[static-methods]",
          "[properties]",
          "[conventional-private-properties]",
          "constructor",
          "[methods]",
          "[conventional-private-methods]"
        ],
        "accessorPairPositioning": "getThenSet"
      }
    ],
    "import/no-duplicates": "error",
    "import/no-unresolved": [
      "error",
      {
        "ignore": ["^src/", "^oa-([a-z]+)/", "^oa-components", "^oa-themes"]
      }
    ],
    "import/newline-after-import": "error",
    "import/no-named-as-default": "off",
    "max-classes-per-file": "error",
    "no-useless-escape": "error",
    "react/display-name": "error",
    "react/jsx-no-target-blank": "warn",
    // https://github.com/standard/eslint-config-standard-with-typescript/issues/248
    "react/no-deprecated": "warn",
    "react/prefer-stateless-function": "error",
    "react/no-unescaped-entities": "off",
    // as of v17 no longer required
    "react/react-in-jsx-scope": "off",
    "react/prop-types": "off",
    "simple-import-sort/imports": [
      "error",
      {
        "groups": [
          // Side effect imports that probably shouldn't be there anyway.
          ["^\\u0000"],
          // Packages `react` related packages come first.
          ["^react", "^@?\\w"],
          // Internal packages.
          ["^(@|components)(/.*|$)"],
          // Relative imports. Put same-folder imports and `.` last.
          [
            "^\\.\\.(?!/?$)",
            "^\\.\\./?$",
            "^\\./(?=.*/)(?!/?$)",
            "^\\.(?!/?$)",
            "^\\./?$"
          ],
          // Type imports seperated out.
          [
            "^node:.*\\u0000$",
            "^@?\\w.*\\u0000$",
            "^[^.].*\\u0000$",
            "^\\..*\\u0000$"
          ],
          // Style imports.
          ["^.+\\.?(css)$"]
        ]
      }
    ],
    "@typescript-eslint/ban-types": [
      "error",
      {
        "types": {
          "React.FC": "`React.FC/React.FunctionComponent is deprecated and should be avoided. Consider using a function declaration instead`"
        }
      }
    ],
    "@typescript-eslint/consistent-type-imports": [
      "error",
      {
        "prefer": "type-imports"
      }
    ],
    "@typescript-eslint/explicit-function-return-type": "off",
    "@typescript-eslint/explicit-module-boundary-types": "off",
    "@typescript-eslint/interface-name-prefix": "off",
    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/naming-convention.md
    // NOTE - typings throughout the platform are fairly inconsistent, hence the wide range of rules

    // 2023-02-17 - Disable as lint check now blocking build (warnings treated as error)
    "@typescript-eslint/naming-convention": [
      "off"
      // {
      //   "selector": "default",
      //   "format": ["camelCase", "UPPER_CASE", "PascalCase", "snake_case"],
      //   "leadingUnderscore": "allow"
      // },
      // {
      //   "selector": "classMethod",
      //   "format": ["camelCase"],
      //   "leadingUnderscore": "allow"
      // }
    ],
    // Filenames - https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md
    "unicorn/filename-case": [
      "error",
      {
        "cases": {
          "camelCase": true,
          "pascalCase": true
        },
        "ignore": ["vite-env.d.ts", "service-worker.ts"]
      }
    ],
    "@typescript-eslint/no-explicit-any": "off",
    "@typescript-eslint/no-inferrable-types": "off",
    "@typescript-eslint/no-use-before-define": "off",
    "@typescript-eslint/no-non-null-assertion": "off",
    "@typescript-eslint/no-empty-interface": "off",
    "@typescript-eslint/no-var-requires": "off",
    "@typescript-eslint/no-namespace": "off",
    "@typescript-eslint/no-unused-vars": "error",
    "no-restricted-imports": [
      "error",
      {
        "paths": [
          // Prevent import of theme-ui link (prefer react-router link as prevents page reload nav)
          {
            "name": "theme-ui",
            "importNames": ["Link"],
            "message": "Please import 'ExternalLink' from 'oa-components' or 'Link' from 'react-router-dom' instead"
          },
          // Prevent importing components from workspace absolute path (prefer workspace name)
          {
            "name": "packages/components/dist",
            "message": "Please import from 'oa-components' instead"
          }
        ]
      }
    ]
  }
}