codeql-action/eslint.config.mjs

import { fixupPluginRules } from "@eslint/compat";
import js from "@eslint/js";
import github from "eslint-plugin-github";
import { importX, createNodeResolver } from "eslint-plugin-import-x";
import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
import noAsyncForeach from "eslint-plugin-no-async-foreach";
import jsdoc from "eslint-plugin-jsdoc";
import tseslint from "typescript-eslint";
import globals from "globals";
import path from "path";
import { fileURLToPath } from "url";

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const githubFlatConfigs = github.getFlatConfigs();

export default [
  {
    ignores: [
      "**/webpack.config.js",
      "build/**/*",
      "lib/**/*",
      "src/testdata/**/*",
      "tests/**/*",
      "build.mjs",
      "ava.config.mjs",
      "ava.setup.mjs",
      "eslint.config.mjs",
      ".github/**/*",
    ],
  },
  // eslint recommended config
  js.configs.recommended,
  // Type-checked rules from typescript-eslint
  ...tseslint.configs.recommendedTypeChecked,
  ...tseslint.configs.strict,
  // eslint-plugin-github recommended config
  githubFlatConfigs.recommended,
  // eslint-plugin-github typescript config
  ...githubFlatConfigs.typescript,
  // import-x TypeScript settings
  // This is needed for import-x rules to properly parse TypeScript files.
  {
    settings: importX.flatConfigs.typescript.settings,
  },
  {
    plugins: {
      "import-x": importX,
      "no-async-foreach": fixupPluginRules(noAsyncForeach),
      jsdoc: jsdoc,
    },

    languageOptions: {
      ecmaVersion: "latest",
      sourceType: "module",

      globals: {
        ...globals.node,
      },

      parserOptions: {
        project: "./tsconfig.json",
      },
    },

    settings: {
      "import/resolver": {
        node: {
          moduleDirectory: ["node_modules", "src"],
        },

        typescript: {},
      },
      "import/ignore": [
        "sinon",
        "uuid",
        "@octokit/plugin-retry",
        "del",
        "get-folder-size",
      ],
      "import-x/resolver-next": [
        createTypeScriptImportResolver(),
        createNodeResolver({
          extensions: [".ts", ".js", ".json"],
        }),
      ],
    },

    rules: {
      "github/filenames-match-regex": ["error", "^[a-z0-9-]+(\\.test)?$"],
      "i18n-text/no-en": "off",

      "import/extensions": [
        "error",
        {
          json: {},
        },
      ],

      "import/no-amd": "error",
      "import/no-commonjs": "error",
      // import/no-cycle does not seem to work with ESLint 9.
      // Use import-x/no-cycle from eslint-plugin-import-x instead.
      "import/no-cycle": "off",
      "import-x/no-cycle": "error",
      "import/no-dynamic-require": "error",

      "import/no-extraneous-dependencies": [
        "error",
        {
          devDependencies: true,
        },
      ],

      "import/no-namespace": "off",
      "import/no-unresolved": "error",
      "import/no-webpack-loader-syntax": "error",

      "import/order": [
        "error",
        {
          alphabetize: {
            order: "asc",
          },

          "newlines-between": "always",
        },
      ],

      "max-len": [
        "error",
        {
          code: 120,
          ignoreUrls: true,
          ignoreStrings: true,
          ignoreTemplateLiterals: true,
        },
      ],

      "no-async-foreach/no-async-foreach": "error",
      "no-sequences": "error",
      "no-shadow": "off",
      // This is overly restrictive with unsetting `EnvVar`s
      "@typescript-eslint/no-dynamic-delete": "off",
      "@typescript-eslint/no-shadow": "error",
      "@typescript-eslint/prefer-optional-chain": "error",
      "one-var": ["error", "never"],

      // Check param names to ensure that we don't have outdated JSDocs.
      "jsdoc/check-param-names": [
        "error",
        {
          // We don't currently require full JSDoc coverage, so this rule
          // should not error on missing @param annotations.
          disableMissingParamChecks: true,
        },
      ],
    },
  },
  {
    files: ["**/*.ts", "**/*.js"],

    rules: {
      "@typescript-eslint/no-explicit-any": "off",
      "@typescript-eslint/no-unsafe-assignment": "off",
      "@typescript-eslint/no-unsafe-enum-comparison": "off",
      "@typescript-eslint/no-unsafe-member-access": "off",
      "@typescript-eslint/no-var-requires": "off",
      "@typescript-eslint/prefer-regexp-exec": "off",
      "@typescript-eslint/require-await": "off",
      "@typescript-eslint/restrict-template-expressions": "off",
      "@typescript-eslint/no-unused-vars": [
        "error",
        {
          args: "all",
          argsIgnorePattern: "^_",
        },
      ],
      "func-style": "off",
    },
  },
  {
    files: ["pr-checks/**/*.ts"],

    languageOptions: {
      parserOptions: {
        // Use the correct `tsconfig.json` for `pr-checks`.
        project: "./pr-checks/tsconfig.json",
      },
    },

    rules: {
      // The scripts in `pr-checks` are expected to output to the console.
      "no-console": "off",

      "import/no-extraneous-dependencies": [
        "error",
        { packageDir: [__dirname, path.resolve(__dirname, "pr-checks")] },
      ],

      "@typescript-eslint/no-floating-promises": [
        "error",
        {
          allowForKnownSafeCalls: [
            // Avoid needing explicit `void` in front of `describe` calls in test files.
            { from: "package", name: ["describe"], package: "node:test" },
          ],
        },
      ],
    },
  },
];