element-call-Github/.eslintrc.cjs

const COPYRIGHT_HEADER = `/*
Copyright %%CURRENT_YEAR%% New Vector Ltd.

SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE in the repository root for full details.
*/

`;

module.exports = {
  plugins: ["matrix-org", "rxjs", "jsdoc"],
  extends: [
    "plugin:matrix-org/react",
    "plugin:matrix-org/a11y",
    "plugin:matrix-org/typescript",
    "prettier",
    "plugin:rxjs/recommended",
  ],
  parserOptions: {
    ecmaVersion: "latest",
    sourceType: "module",
    project: ["./tsconfig.json"],
  },
  env: {
    browser: true,
    node: true,
  },
  rules: {
    "jsdoc/no-types": "error",
    "jsdoc/empty-tags": "error",
    "jsdoc/check-property-names": "error",
    "jsdoc/check-values": "error",
    "jsdoc/check-param-names": "warn",
    // "jsdoc/require-param": "warn",
    "jsdoc/require-param-description": "warn",
    "matrix-org/require-copyright-header": ["error", COPYRIGHT_HEADER],
    "jsx-a11y/media-has-caption": "off",
    "react/display-name": "error",
    // Encourage proper usage of Promises:
    "@typescript-eslint/no-floating-promises": "error",
    "@typescript-eslint/no-misused-promises": "error",
    "@typescript-eslint/promise-function-async": "error",
    "@typescript-eslint/require-await": "error",
    "@typescript-eslint/await-thenable": "error",
    // To help ensure that we get proper vite/rollup lazy loading (e.g. for matrix-js-sdk):
    "@typescript-eslint/consistent-type-imports": [
      "error",
      { fixStyle: "inline-type-imports" },
    ],
    // To encourage good usage of RxJS:
    "rxjs/no-exposed-subjects": "error",
    "rxjs/finnish": ["error", { names: { "^this$": false } }],
    "no-restricted-imports": [
      "error",
      {
        paths: ["matrix-widget-api", "matrix-js-sdk"].flatMap((lib) =>
          ["src", "src/", "src/index", "lib", "lib/", "lib/index"]
            .map((path) => `${lib}/${path}`)
            .map((name) => ({ name, message: `Please use ${lib} instead` })),
        ),
        patterns: [
          ...["matrix-widget-api"].map((lib) => ({
            group: ["src", "src/", "src/**", "lib", "lib/", "lib/**"].map(
              (path) => `${lib}/${path}`,
            ),
            message: `Please use ${lib} instead`,
          })),
          // XXX: We use /lib in lots of places, so allow for now.
          ...["matrix-js-sdk"].map((lib) => ({
            group: ["src", "src/", "src/**"].map((path) => `${lib}/${path}`),
            message: `Please use ${lib} instead`,
          })),
        ],
      },
    ],
  },
  overrides: [
    {
      files: ["src/*/**"],
      rules: {
        // In application code we should use the js-sdk logger, never console directly.
        "no-console": ["error"],
      },
    },
    {
      files: [
        "**/*.test.ts",
        "**/*.test.tsx",
        "**/test.ts",
        "**/test.tsx",
        "**/test-**",
      ],
      rules: {
        "jsdoc/no-types": "off",
        "jsdoc/empty-tags": "off",
        "jsdoc/check-property-names": "off",
        "jsdoc/check-values": "off",
        "jsdoc/check-param-names": "off",
        "jsdoc/require-param-description": "off",
      },
    },
    {
      files: ["playwright/**"],
      rules: {
        // Playwright as a `use` function that has nothing to do with React hooks.
        "react-hooks/rules-of-hooks": "off",
      },
    },
  ],
  settings: {
    react: {
      version: "detect",
    },
  },
};