@forsakringskassan/eslint-config 12.2.2 → 13.0.1

package/eslint.js

@@ -6,6 +6,7 @@ const { spawn } = require("child_process");
 const pkgPath = path.dirname(require.resolve("eslint/package.json"));
 const binary = path.join(pkgPath, "bin/eslint");
 
+/* eslint-disable-next-line sonarjs/no-os-command-from-path -- want to run it from path */
 spawn("node", [binary, ...process.argv.slice(2)], {
     stdio: "inherit",
 }).on("exit", (code) => {

package/index.d.mts

@@ -0,0 +1,11 @@
+import { Linter } from "eslint";
+
+declare const config: Linter.Config[];
+export const globals: typeof import("globals");
+
+export default config;
+
+export function defineConfig(config: Linter.Config): Linter.Config;
+export function docsConfig(override?: Linter.Config): Linter.Config;
+export function examplesConfig(override?: Linter.Config): Linter.Config;
+export function sandboxConfig(override?: Linter.Config): Linter.Config;

package/{flat.mjs → index.mjs}

@@ -2,7 +2,7 @@ import { fileURLToPath } from "node:url";
 import js from "@eslint/js";
 import prettierConfig from "eslint-config-prettier";
 import importPlugin from "eslint-plugin-import";
-import eslintCommentsPlugin from "eslint-plugin-eslint-comments";
+import eslintCommentsPlugin from "@eslint-community/eslint-plugin-eslint-comments";
 import prettierPlugin from "eslint-plugin-prettier";
 import sonarjsPlugin from "eslint-plugin-sonarjs";
 import globals from "globals";
@@ -17,10 +17,25 @@ export { default as globals } from "globals";
  * @param {Config} config
  * @returns {Config}
  */
-function defineConfig(config) {
+export function defineConfig(config) {
     return config;
 }
 
+/**
+ * @param {Config} result
+ * @param {Config} it
+ * @returns {Config}
+ */
+function merge(result, it) {
+    return {
+        ...result,
+        ...it,
+        languageOptions: { ...result.languageOptions, ...it.languageOptions },
+        plugins: { ...result.plugins, ...it.plugins },
+        rules: { ...result.rules, ...it.rules },
+    };
+}
+
 export default [
     defineConfig({
         ...js.configs.recommended,
@@ -30,7 +45,7 @@ export default [
         plugins: {
             prettier: prettierPlugin,
             import: importPlugin,
-            "eslint-comments": eslintCommentsPlugin,
+            "@eslint-community/eslint-comments": eslintCommentsPlugin,
             sonarjs: sonarjsPlugin,
         },
         settings: {
@@ -78,11 +93,11 @@ export default [
             radix: "error",
             yoda: "error",
 
-            "eslint-comments/disable-enable-pair": [
+            "@eslint-community/eslint-comments/disable-enable-pair": [
                 "error",
                 { allowWholeFile: true },
             ],
-            "eslint-comments/require-description": [
+            "@eslint-community/eslint-comments/require-description": [
                 "error",
                 {
                     ignore: [
@@ -94,7 +109,7 @@ export default [
                     ],
                 },
             ],
-            "eslint-comments/no-unused-disable": "error",
+            "@eslint-community/eslint-comments/no-unused-disable": "error",
 
             /* Use eslint native complexity rule instead */
             "sonarjs/cognitive-complexity": "off",
@@ -109,6 +124,23 @@ export default [
              * keys. */
             "sonarjs/no-duplicate-string": "off",
 
+            "sonarjs/argument-type": "off", // handled by typescript (and this rule is sometimes wrong)
+            "sonarjs/deprecation": "off", // covered by @typescript-eslint/no-deprecated (and this rule crashes on .svelte files)
+            "sonarjs/function-return-type": "off", // overly broad and opinionated, let typescript deal with this
+            "sonarjs/no-control-regex": "off", // covered by no-control-regexp
+            "sonarjs/no-empty-test-file": "off", // could be useful but it does not handle it.each or similar constructs thus yields more false positives than its worth */
+            "sonarjs/no-selector-parameter": "off", // not always possible (e.g. watcher handler in vue)
+            "sonarjs/no-skipped-tests": "off", // covered by jest/no-disabled-tests and mocha/no-pending-tests
+            "sonarjs/no-small-switch": "off", // prefer to use small switches when the intention is to all more cases later
+            "sonarjs/no-unused-vars": "off", // covered by @typescript-eslint/no-unused-vars
+            "sonarjs/prefer-nullish-coalescing": "off", // requires typescript and strictNullChecks, which is sane, but we also use @typescript-eslint/prefer-nullish-coalescing so this becomes redundant
+            "sonarjs/prefer-regexp-exec": "off", // covered by @typescript-eslint/prefer-regexp-exec
+            "sonarjs/redundant-type-aliases": "off", // "redundant" type aliases helps with self-documenting code
+            "sonarjs/todo-tag": "off", // want to be able to leave todo tasks
+            "sonarjs/unused-import": "off", // covered by @typescript-eslint/no-unused-vars
+            "sonarjs/unused-named-groups": "off", // named groups can help readability even if not used
+            "sonarjs/use-type-alias": "off", // overly broad, lets leave this to the discretion of the author
+
             /* Lower some errors to warnings, these are allowed on local builds (to
              * not prevent builds during development where code is unfinished and
              * might contain debugging code) but is disallowed when building from
@@ -116,6 +148,7 @@ export default [
             "no-console": "warn",
             "no-debugger": "warn",
             "prettier/prettier": "warn",
+            "sonarjs/no-commented-code": "warn",
 
             "import/default": "off",
             "import/extensions": [
@@ -196,4 +229,83 @@ export default [
             "import/extensions": ["error", "always"],
         },
     }),
+
+    /* These legacy files points to compiled files which may or may not exist
+     * yet */
+    defineConfig({
+        name: "@forsakringskassan/eslint-config/legacy-dts",
+        files: ["packages/*/*.d.ts"],
+        rules: {
+            "import/no-unresolved": "off",
+        },
+    }),
+
+    /* E2E tests may import pageobjects from monorepo packages but the import
+     * plugin wont resolve them, yielding lots of false positives */
+    {
+        name: "@forsakringskassan/eslint-config/cypress-pageobjects",
+        files: ["cypress/**/*.[jt]s"],
+        rules: {
+            "import/no-extraneous-dependencies": "off",
+            "import/order": "off",
+        },
+    },
 ];
+
+const defaultDocsConfig = defineConfig({
+    name: "@forsakringskassan/eslint-config/docs-app",
+    files: ["docs/src/*.{js,ts}"],
+    languageOptions: {
+        globals: {
+            ...globals.browser,
+        },
+    },
+});
+
+const defaultExampleConfig = {
+    name: "@forsakringskassan/eslint-config/docs-examples",
+    files: ["**/examples/**/*.{js,ts,vue}"],
+    rules: {
+        "@eslint-community/eslint-comments/require-description": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "import/no-duplicates": "off",
+        "import/no-extraneous-dependencies": "off",
+        "no-console": "off",
+        "no-unused-vars": "off",
+        "sonarjs/no-dead-store": "off",
+        "sonarjs/pseudo-random": "off",
+    },
+};
+
+const defaultSandboxConfig = {
+    name: "@forsakringskassan/eslint-config/sandbox",
+    files: ["internal/vue-sandbox/**/*.{js,ts,vue}"],
+    rules: {
+        "no-console": "off",
+    },
+};
+
+/**
+ * @param {Config} [override]
+ * @returns {Config}
+ */
+export function docsConfig(override) {
+    return merge(defaultDocsConfig, override ?? {});
+}
+
+/**
+ * @param {Config} [override]
+ * @returns {Config}
+ */
+export function examplesConfig(override) {
+    return merge(defaultExampleConfig, override ?? {});
+}
+
+/**
+ * @param {Config} [override]
+ * @returns {Config}
+ */
+export function sandboxConfig(override) {
+    return merge(defaultSandboxConfig, override ?? {});
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/eslint-config",
-  "version": "12.2.2",
+  "version": "13.0.1",
   "description": "Försäkringskassans eslint shareable config",
   "keywords": [
     "eslint"
@@ -14,35 +14,32 @@
   },
   "license": "MIT",
   "author": "Försäkringskassan",
-  "main": "index.cjs",
+  "main": "index.mjs",
   "bin": {
     "eslint": "eslint.js"
   },
   "files": [
-    "patch",
     "eslint.js",
-    "flat.mjs",
-    "flat.d.mts",
-    "index.cjs"
+    "index.mjs",
+    "index.d.mts"
   ],
   "dependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
     "@eslint/js": "9.35.0",
-    "@rushstack/eslint-patch": "1.12.0",
-    "eslint": "8.57.1",
+    "eslint": "9.35.0",
     "eslint-config-prettier": "10.1.8",
     "eslint-import-resolver-node": "0.3.9",
     "eslint-import-resolver-typescript": "4.4.4",
-    "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-prettier": "5.5.4",
-    "eslint-plugin-sonarjs": "1.0.4",
-    "globals": "14.0.0"
+    "eslint-plugin-sonarjs": "3.0.5",
+    "globals": "16.4.0"
   },
   "peerDependencies": {
     "prettier": "^2.0.0 || ^3.0.0"
   },
   "engines": {
-    "node": ">= 20.19"
+    "node": ">= 22.0"
   },
-  "gitHead": "ada50dccddcd01d906f764576493c5a1ebbe4253"
+  "gitHead": "57b963a69b2ccca19ef2573910796c5c8a251582"
 }

package/flat.d.mts

@@ -1,6 +0,0 @@
-import { Linter } from "eslint";
-
-declare const config: Linter.Config[];
-export const globals: typeof import("globals");
-
-export default config;

package/index.cjs

@@ -1,130 +0,0 @@
-module.exports = {
-    extends: [
-        "eslint:recommended",
-        "plugin:prettier/recommended",
-        "plugin:import/errors",
-        "plugin:eslint-comments/recommended",
-        "plugin:sonarjs/recommended-legacy",
-    ],
-
-    env: {
-        es6: true,
-        node: true,
-    },
-
-    parserOptions: {
-        ecmaVersion: 2022,
-        sourceType: "module",
-    },
-
-    settings: {
-        "import/resolver": {
-            [require.resolve("eslint-import-resolver-node")]: true,
-            [require.resolve("eslint-import-resolver-typescript")]: true,
-        },
-    },
-
-    rules: {
-        camelcase: "error",
-        complexity: ["error", 20],
-        "consistent-return": "error",
-        curly: "error",
-        eqeqeq: "error",
-        "max-depth": ["error", 3],
-        "max-params": ["error", { max: 5 }],
-        "no-eval": "error",
-        "no-implied-eval": "error",
-        "no-loop-func": "error",
-        "no-new": "error",
-        "no-new-func": "error",
-        "no-unreachable": "error",
-        "no-unused-vars": "error",
-        "no-var": "error",
-        "no-warning-comments": "error",
-        "prefer-const": "error",
-        "prefer-rest-params": "error",
-        "prefer-spread": "error",
-        "prefer-template": "error",
-        radix: "error",
-        yoda: "error",
-
-        "eslint-comments/disable-enable-pair": [
-            "error",
-            { allowWholeFile: true },
-        ],
-        "eslint-comments/require-description": [
-            "error",
-            {
-                ignore: [
-                    "eslint-enable",
-                    "eslint-env",
-                    "exported",
-                    "global",
-                    "globals",
-                ],
-            },
-        ],
-        "eslint-comments/no-unused-disable": "error",
-
-        /* Use eslint native complexity rule instead */
-        "sonarjs/cognitive-complexity": "off",
-
-        /* Prefer to use multiple returns even for booleans (looks better and
-         * can yield performance increase), see example of this in
-         * "example.js". */
-        "sonarjs/prefer-single-boolean-return": "off",
-
-        /* This rule is deemed to provide more trouble than actual value.
-         * Especially because of the prevalence of translations, i.e., text
-         * keys. */
-        "sonarjs/no-duplicate-string": "off",
-
-        /* Lower some errors to warnings, these are allowed on local builds (to
-         * not prevent builds during development where code is unfinished and
-         * might contain debugging code) but is disallowed when building from
-         * Jenkins (via `--max-warnings 0`) */
-        "no-console": "warn",
-        "no-debugger": "warn",
-        "prettier/prettier": "warn",
-
-        "import/default": "off",
-        "import/extensions": [
-            "error",
-            "never",
-            {
-                css: "always",
-                json: "always",
-            },
-        ],
-        "import/newline-after-import": "error",
-        "import/no-absolute-path": "error",
-        "import/no-deprecated": "error",
-        "import/no-duplicates": "error",
-        "import/no-dynamic-require": "error",
-        "import/no-extraneous-dependencies": "error",
-        "import/no-mutable-exports": "error",
-        "import/no-named-as-default": "error",
-        "import/no-named-as-default-member": "error",
-        "import/no-named-default": "error",
-        "import/no-unresolved": [
-            "error",
-            {
-                /* neither of the resolvers will handle @ alias */
-                ignore: ["^@"],
-            },
-        ],
-        "import/no-useless-path-segments": "error",
-        "import/order": [
-            "error",
-            {
-                pathGroups: [
-                    {
-                        pattern: "@/**",
-                        group: "parent",
-                        position: "before",
-                    },
-                ],
-            },
-        ],
-    },
-};

package/patch/modern-module-resolution.js

@@ -1 +0,0 @@
-require("@rushstack/eslint-patch/modern-module-resolution");