@forsakringskassan/eslint-config 13.0.0 → 13.0.2

package/index.d.mts

@@ -4,3 +4,8 @@ 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/index.mjs

@@ -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,
@@ -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,94 @@ 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: ["*.d.ts", "packages/*/*.d.ts"],
+        rules: {
+            "import/no-unresolved": "off",
+        },
+    }),
+
+    defineConfig({
+        name: "@forsakringskassan/eslint-config/bin",
+        files: ["bin/*.{js,cjs,mjs}"],
+        rules: {
+            /* esm requires the usage of extension in this context */
+            "import/extensions": "off",
+            /* needed to run eslint before sources are compiled to dist folder */
+            "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": "13.0.0",
+  "version": "13.0.2",
   "description": "Försäkringskassans eslint shareable config",
   "keywords": [
     "eslint"
@@ -41,5 +41,5 @@
   "engines": {
     "node": ">= 22.0"
   },
-  "gitHead": "6e466e321dc87d4d3e525bbf1711e8ae9f6b8742"
+  "gitHead": "99ad23a49dac0b99b44be7190639b0dfb5d27355"
 }