eslint.config.js

import dwpConfig from "@dwp/eslint-config-base";
import securityPlugin from "eslint-plugin-security";
import jsdocsPlugin from "eslint-plugin-jsdoc";
import sonarjsPlugin from "eslint-plugin-sonarjs";
import importPlugin from "eslint-plugin-import";

export default [
  ...dwpConfig,
  securityPlugin.configs.recommended,
  jsdocsPlugin.configs["flat/recommended"],
  sonarjsPlugin.configs.recommended,
  importPlugin.flatConfigs.recommended,
  {
    files: ["**/*.{js,mjs,cjs}"],
    languageOptions: {
      ecmaVersion: "latest",
      sourceType: "module",
    },
  },
  {
    rules: {
      "jsdoc/tag-lines": ["warn", "any", { startLines: 1 }],
      "sonarjs/todo-tag": "warn",
      "sonarjs/cognitive-complexity": ["warn", 15],
      "sonarjs/public-static-readonly": "off" /* Can only use in TypeScript */,
    },
  },
  {
    name: "Global ignore list",
    ignores: [
      "assets/**/*",
      "dist/**/*",
      "examples/**/*",
      "scripts/**/*",
      "docs/api/**/*",
    ],
  },
  {
    name: "Test files",
    files: ["tests/**/*.js"],
    languageOptions: {
      globals: {
        it: "readonly",
        describe: "readonly",
        beforeEach: "readonly",
        afterEach: "readonly",
      },
    },
    rules: {
      "jsdoc/require-param-description": "off",
      "jsdoc/require-param-type": "off",
      "jsdoc/require-returns": "off",
      "security/detect-object-injection": "off",
      "sonarjs/no-nested-functions": "off",
    },
  },
  {
    name: "Validators",
    files: ["src/lib/validators/**/*.js"],
    rules: {
      // the API docs builder requires use of @memberof which raises this finding
      "jsdoc/no-undefined-types": "off",
    },
  },
];