Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

3.2 KB
Raw Blame
// Standalone eslint config for running only module boundary linting.
//
// Usage: bunx eslint --config eslint.config.module-boundaries.mjs "frontend/src/**/*.{js,jsx,ts,tsx}" "enterprise/frontend/src/**/*.{js,jsx,ts,tsx}"

import path from "path";
import { fileURLToPath } from "url";

import boundaries from "eslint-plugin-boundaries";
import react from "eslint-plugin-react";
import { globalIgnores, defineConfig } from "eslint/config";
import tseslint from "typescript-eslint";

const __dirname = path.dirname(fileURLToPath(import.meta.url));

import {
  elements as boundaryElements,
  rules as boundaryRules,
} from "./frontend/lint/module-boundaries.mjs";
import { ruleAliases } from "./frontend/lint/oxlint/rule-aliases.mjs";

// dummy plugins to keep eslint from complaining about missing plugins and settings
const alwaysPassingRule = {
  meta: {
    type: "problem",
    docs: {
      description: "stub for ttag/no-module-declaration - always passes",
    },
    schema: [],
  },

  create() {
    // Return an empty visitor object - this rule does nothing and always passes
    return {};
  },
};

// Resolve any rule name to the always-passing stub, so eslint-disable
// directives don't error with "Definition for rule ... was not found".
const alwaysPassingPlugin = {
  rules: new Proxy(
    {},
    {
      get: () => alwaysPassingRule,
      has: () => true,
    },
  ),
};

export default defineConfig([
  globalIgnores(["**/e2e/**", "test/**"]),
  {
    linterOptions: {
      reportUnusedDisableDirectives: "off",
    },
    files: [
      "frontend/src/**/*.{ts,tsx}",
      "enterprise/frontend/src/**/*.{ts,tsx}",
    ],
    languageOptions: {
      parser: tseslint.parser,
      parserOptions: {
        ecmaFeatures: {
          jsx: true,
        },
      },
    },
    plugins: {
      ...Object.fromEntries(
        Object.values(ruleAliases).map((rule) => [
          rule.split("/")[0],
          alwaysPassingPlugin,
        ]),
      ),
      ttag: alwaysPassingPlugin,
      metabase: alwaysPassingPlugin,
      import: alwaysPassingPlugin,
      i18next: alwaysPassingPlugin,
      "react-hooks": alwaysPassingPlugin,
      "@typescript-eslint": alwaysPassingPlugin,
      "testing-library": alwaysPassingPlugin,
      jest: alwaysPassingPlugin,
      "jest-dom": alwaysPassingPlugin,
      boundaries,
      react,
    },
    settings: {
      "boundaries/elements": boundaryElements,
      "boundaries/ignore": ["**/e2e/**", "test/**"],
      "boundaries/dependency-nodes": ["import", "dynamic-import"],
      "import-x/resolver": {
        node: true,
        webpack: {
          config: path.resolve(__dirname, "./rspack.main.config.js"),
          typescript: true,
        },
      },
      "import/resolver": {
        node: true,
        webpack: {
          config: path.resolve(__dirname, "./rspack.main.config.js"),
          typescript: true,
        },
      },
    },
    rules: {
      "boundaries/element-types": [
        "error",
        {
          default: "disallow",
          rules: boundaryRules,
        },
      ],
      // Every file frontend/src/ and enterprise/frontend/src/ must belong to a declared module.
      "boundaries/no-unknown-files": "error",
    },
  },
]);