radicle-explorer/shared/ui/eslint.base.js

import globals from "globals";
import js from "@eslint/js";
import prettier from "eslint-config-prettier";
import svelte from "eslint-plugin-svelte";
import simpleImportSort from "eslint-plugin-simple-import-sort";
import svelteParser from "svelte-eslint-parser";
import ts from "typescript-eslint";

// Browser globals that are easy to use by accident in place of a local
// variable of the same name.
export const restrictedGlobals = [
  "name",
  "event",
  "frames",
  "history",
  "length",
  "content",
  "origin",
  "status",
];

// The ESLint config shared by shared/ui and desktop. `rootDir` is the
// directory of the caller's tsconfig.json, `importGroups` are extra
// simple-import-sort groups placed before relative imports, and `ignores` are
// the caller's ignored paths.
export function radicleConfig({ rootDir, importGroups = [], ignores = [] }) {
  return [
    ...[
      js.configs.recommended,
      ...ts.configs.recommended,
      prettier,
      {
        plugins: {
          "simple-import-sort": simpleImportSort,
        },
        languageOptions: {
          parser: ts.parser,
          parserOptions: {
            project: "./tsconfig.json",
            tsconfigRootDir: rootDir,
            extraFileExtensions: [".svelte", ".svelte.ts"],
          },
          globals: { ...globals.browser, ...globals.node },
        },
        rules: {
          "no-implicit-globals": "error",
          "no-restricted-globals": ["error", ...restrictedGlobals],
          // Require using arrow functions as callbacks.
          // https://eslint.org/docs/rules/prefer-arrow-callback
          "prefer-arrow-callback": "warn",
          // Require using const for variables that are never modified after declared.
          // https://eslint.org/docs/rules/prefer-const
          "prefer-const": "warn",
          // Disallow modifying variables that are declared using const.
          // https://eslint.org/docs/rules/no-const-assign
          "no-const-assign": "error",
          // Require let or const instead of var.
          // https://eslint.org/docs/rules/no-var
          "no-var": "warn",
          "simple-import-sort/imports": [
            "warn",
            {
              groups: [
                // Type imports
                ["\\u0000$"],
                // Node.js built-in modules
                ["^node:"],
                // Everything not matched, aka third party packages
                ["^"],
                ...importGroups,
                // Everything else imported through relative imports
                ["^\\."],
              ],
            },
          ],
          // Require `===` and `!==` comparisons.
          eqeqeq: "warn",
          "@typescript-eslint/no-floating-promises": "warn",
          "@typescript-eslint/no-empty-function": "warn",
          "@typescript-eslint/naming-convention": [
            "warn",
            {
              selector: "enumMember",
              format: ["PascalCase"],
            },
            {
              selector: "objectLiteralProperty",
              format: ["PascalCase", "camelCase"],
            },
            {
              selector: "default",
              format: ["camelCase"],
              leadingUnderscore: "allow",
              trailingUnderscore: "allow",
            },
            {
              selector: "variable",
              modifiers: ["const"],
              format: ["camelCase", "PascalCase", "UPPER_CASE"],
              leadingUnderscore: "allow",
              trailingUnderscore: "allow",
            },
            {
              selector: "typeLike",
              format: ["PascalCase"],
            },
            // Disable @typescript-eslint/naming-convention format for imports
            // https://github.com/typescript-eslint/typescript-eslint/pull/7269#issuecomment-1777628591
            // https://github.com/typescript-eslint/typescript-eslint/issues/7892
            { selector: "import", format: null },
            {
              selector: ["objectLiteralProperty"],
              modifiers: ["requiresQuotes"],
              format: null,
            },
          ],
          "@typescript-eslint/no-namespace": [
            "error",
            { allowDeclarations: true },
          ],
          "@typescript-eslint/member-ordering": [
            "warn",
            { default: ["field", "signature", "constructor", "method"] },
          ],
          // Allow explicit type annotations for additional clarity.
          "@typescript-eslint/no-inferrable-types": "off",
          "@typescript-eslint/no-invalid-void-type": ["warn"],
          // Disallow Unused Variables.
          // https://eslint.org/docs/rules/no-unused-vars
          "@typescript-eslint/no-unused-vars": [
            "warn",
            { argsIgnorePattern: "^_" },
          ],
        },
      },
    ].map(conf => ({
      ...conf,
      linterOptions: {
        reportUnusedDisableDirectives: "error",
      },
      files: ["**/*.js", "**/*.ts", "**/*.svelte"],
    })),
    ...svelte.configs["flat/recommended"],
    ...svelte.configs["flat/prettier"],
    {
      files: ["*.svelte", "**/*.svelte", "**/*.svelte.ts"],
      languageOptions: {
        parser: svelteParser,
        parserOptions: {
          parser: ts.parser,
          project: "./tsconfig.json",
          tsconfigRootDir: rootDir,
          svelteFeatures: {
            experimentalGenerics: true,
          },
        },
      },
      rules: {
        "svelte/require-each-key": "off",
        "svelte/no-at-html-tags": "off",
        "@typescript-eslint/no-explicit-any": "error",
      },
    },
    { ignores },
  ];
}