// @ts-check import { fixupPluginRules } from "@eslint/compat"; import { FlatCompat } from "@eslint/eslintrc"; import eslint from "@eslint/js"; import mochaPlugin from "eslint-plugin-mocha"; import playwright from "eslint-plugin-playwright"; import prettierRecommended from "eslint-plugin-prettier/recommended"; import reactCompiler from "eslint-plugin-react-compiler"; import reactHooks from "eslint-plugin-react-hooks"; import reactJsxRuntime from "eslint-plugin-react/configs/jsx-runtime.js"; import reactRecommended from "eslint-plugin-react/configs/recommended.js"; import tseslint from "typescript-eslint"; const compat = new FlatCompat({ baseDirectory: import.meta.dirname, }); export default tseslint.config( { ignores: [ "**/dist/", "**/lib/", "**/target/", "./apps/keycloak-server/server/", // Keycloak JS follows a completely different and outdated style, so we'll exclude it for now. "./libs/keycloak-js/", ], }, eslint.configs.recommended, ...tseslint.configs.strictTypeChecked, ...tseslint.configs.stylisticTypeChecked, reactRecommended, reactJsxRuntime, prettierRecommended, ...compat.plugins("lodash"), { plugins: { "react-hooks": fixupPluginRules(reactHooks), "react-compiler": reactCompiler, }, languageOptions: { parserOptions: { project: "./tsconfig.eslint.json", tsconfigRootDir: import.meta.dirname, }, }, settings: { react: { version: "18", }, }, rules: { ...reactHooks.configs.recommended.rules, "react-compiler/react-compiler": "warn", // ## Rules overwriting config, disabled for now, but will have to be evaluated. ## "no-undef": "off", "no-unused-private-class-members": "off", "@typescript-eslint/array-type": "off", "@typescript-eslint/ban-ts-comment": "off", "@typescript-eslint/ban-tslint-comment": "off", "@typescript-eslint/ban-types": "off", "@typescript-eslint/consistent-indexed-object-style": "off", "@typescript-eslint/consistent-type-definitions": "off", "@typescript-eslint/dot-notation": "off", "@typescript-eslint/no-base-to-string": "off", "@typescript-eslint/no-confusing-non-null-assertion": "off", "@typescript-eslint/no-confusing-void-expression": "off", "@typescript-eslint/no-duplicate-type-constituents": "off", "@typescript-eslint/no-dynamic-delete": "off", "@typescript-eslint/no-explicit-any": "off", "@typescript-eslint/no-extraneous-class": "off", "@typescript-eslint/no-floating-promises": "off", "@typescript-eslint/no-inferrable-types": "off", "@typescript-eslint/no-invalid-void-type": "off", "@typescript-eslint/no-misused-promises": "off", "@typescript-eslint/no-non-null-asserted-optional-chain": "off", "@typescript-eslint/no-non-null-assertion": "off", "@typescript-eslint/no-redundant-type-constituents": "off", "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off", "@typescript-eslint/no-unnecessary-condition": "off", "@typescript-eslint/no-unnecessary-type-arguments": "off", "@typescript-eslint/no-unnecessary-type-assertion": "off", "@typescript-eslint/no-unnecessary-type-parameters": "off", "@typescript-eslint/no-unsafe-argument": "off", "@typescript-eslint/no-unsafe-assignment": "off", "@typescript-eslint/no-unsafe-call": "off", "@typescript-eslint/no-unsafe-enum-comparison": "off", "@typescript-eslint/no-unsafe-member-access": "off", "@typescript-eslint/no-unsafe-return": "off", "@typescript-eslint/no-useless-constructor": "off", "@typescript-eslint/no-useless-template-literals": "off", "@typescript-eslint/non-nullable-type-assertion-style": "off", "@typescript-eslint/only-throw-error": "off", "@typescript-eslint/prefer-for-of": "off", "@typescript-eslint/prefer-nullish-coalescing": "off", "@typescript-eslint/prefer-promise-reject-errors": "off", "@typescript-eslint/prefer-reduce-type-parameter": "off", "@typescript-eslint/prefer-ts-expect-error": "off", "@typescript-eslint/require-await": "off", "@typescript-eslint/restrict-plus-operands": "off", "@typescript-eslint/restrict-template-expressions": "off", "@typescript-eslint/unbound-method": "off", "@typescript-eslint/use-unknown-in-catch-callback-variable": "off", // ## Rules that are customized because of team preferences or other issues ## // Prevent default imports from React, named imports should be used instead. // This is a team preference, but also helps us enforce consistent imports. "no-restricted-imports": [ "error", { paths: [ { name: "react", importNames: ["default"], }, ], }, ], // Prefer using the `#private` syntax for private class members, we want to keep this consistent and use the same syntax. "no-restricted-syntax": [ "error", { selector: ':matches(PropertyDefinition, MethodDefinition)[accessibility="private"]', message: "Use #private instead", }, ], // Require using arrow functions for callbacks, the team prefers this style over inconsistent function declarations. "prefer-arrow-callback": "error", // `react/prop-types` cannot handle generic props, so we need to disable it. // https://github.com/yannickcr/eslint-plugin-react/issues/2777#issuecomment-814968432 "react/prop-types": "off", // Prevent fragments from being added that have only a single child. "react/jsx-no-useless-fragment": "error", // Ban nesting components, as this will cause unintended re-mounting of components. // See: https://react.dev/learn/your-first-component#nesting-and-organizing-components "react/no-unstable-nested-components": ["error", { allowAsProps: true }], // Prefer a specific import scope (e.g. `lodash/map` vs `lodash`). // Allows for more efficient tree-shaking and better code splitting. "lodash/import-scope": ["error", "member"], }, }, ...[ ...compat.extends("plugin:cypress/recommended"), mochaPlugin.configs.flat.recommended, ].map((config) => ({ ...config, files: ["**/cypress/**/*"], })), { files: ["**/cypress/**/*"], // TODO: Set these rules to "error" when issues have been resolved. rules: { "cypress/no-unnecessary-waiting": "warn", "cypress/unsafe-to-chain-command": "warn", "mocha/max-top-level-suites": "off", "mocha/no-exclusive-tests": "error", "mocha/no-identical-title": "off", "mocha/no-mocha-arrows": "off", "mocha/no-setup-in-describe": "off", }, }, { ...playwright.configs["flat/recommended"], files: ["js/apps/account-ui/test/**"], }, { files: ["js/libs/keycloak-admin-client/test/**"], rules: { "@typescript-eslint/no-unused-expressions": "off", }, }, { files: ["js/libs/keycloak-admin-client/src/**"], rules: { "@typescript-eslint/no-empty-object-type": "off", }, }, );