@echoes-of-order/eslint-config 1.121.0

package/rules/forbid-fromentity-outside-entity-folder.js

@@ -0,0 +1,237 @@
+/**
+ * ESLint-Regel: Verbotet fromEntity-Methoden außerhalb des /dto/Entity/ Ordners
+ *
+ * Diese Regel stellt sicher, dass:
+ * - DTOs im /dto/Entity/ Ordner fromEntity-Methoden haben DÜRFEN
+ * - DTOs außerhalb des /dto/Entity/ Ordners KEINE fromEntity-Methoden haben DÜRFEN
+ * - Request-, Response- und andere DTOs sind reine Datenstrukturen ohne Entity-Konvertierung
+ */
+
+/** @type {import('eslint').Rule.RuleModule} */
+const forbidFromEntityOutsideEntityFolderRule = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "fromEntity-Methoden sind nur in DTOs im /dto/Entity/ Ordner erlaubt",
+      category: "Architecture",
+      recommended: true,
+    },
+    hasSuggestions: true,
+    schema: [],
+    messages: {
+      forbiddenFromEntityOutsideEntityFolder: "fromEntity-Methode ist in DTO '{{dtoName}}' nicht erlaubt. Diese Datei liegt außerhalb des /dto/Entity/ Ordners. fromEntity-Methoden sind nur für Entity-DTOs erlaubt.",
+      forbiddenFromEntityArrayOutsideEntityFolder: "fromEntityArray-Methode ist in DTO '{{dtoName}}' nicht erlaubt. Diese Datei liegt außerhalb des /dto/Entity/ Ordners. fromEntityArray-Methoden sind nur für Entity-DTOs erlaubt.",
+      suggestMoveToEntityFolder: "DTO '{{dtoName}}' sollte in den /dto/Entity/ Ordner verschoben werden, wenn es Entity-Konvertierung benötigt.",
+      suggestRemoveFromEntityMethod: "fromEntity-Methode entfernen, da dieser DTO keine Entity-Konvertierung benötigt.",
+    },
+  },
+
+  create(context) {
+    return {
+      ClassDeclaration(node) {
+        const filename = context.getFilename();
+        const dtoName = node.id?.name;
+
+        if (!dtoName || !dtoName.endsWith("Dto")) {
+          return; // Kein DTO
+        }
+
+        // Prüfe, ob die Datei im /dto/Entity/ Ordner liegt
+        const isInEntityFolder = filename.includes("/dto/Entity/");
+
+        if (isInEntityFolder) {
+          return; // Entity-DTOs dürfen fromEntity-Methoden haben
+        }
+
+        // Prüfe auf fromEntity und fromEntityArray Methoden
+        const hasFromEntity = node.body.body.some(member =>
+          member.type === "MethodDefinition" &&
+          member.static &&
+          member.key?.name === "fromEntity"
+        );
+
+        const hasFromEntityArray = node.body.body.some(member =>
+          member.type === "MethodDefinition" &&
+          member.static &&
+          member.key?.name === "fromEntityArray"
+        );
+
+        if (hasFromEntity) {
+          context.report({
+            node,
+            messageId: "forbiddenFromEntityOutsideEntityFolder",
+            data: {
+              dtoName,
+            },
+            suggest: [
+              {
+                messageId: "suggestMoveToEntityFolder",
+                data: { dtoName },
+                fix: () => null, // Keine automatische Korrektur
+              },
+              {
+                messageId: "suggestRemoveFromEntityMethod",
+                data: { dtoName },
+                fix: (fixer) => {
+                  // Finde und entferne die fromEntity-Methode
+                  const fromEntityMethod = node.body.body.find(member =>
+                    member.type === "MethodDefinition" &&
+                    member.static &&
+                    member.key?.name === "fromEntity"
+                  );
+
+                  if (fromEntityMethod) {
+                    return fixer.remove(fromEntityMethod);
+                  }
+                  return null;
+                },
+              },
+            ],
+          });
+        }
+
+        if (hasFromEntityArray) {
+          context.report({
+            node,
+            messageId: "forbiddenFromEntityArrayOutsideEntityFolder",
+            data: {
+              dtoName,
+            },
+            suggest: [
+              {
+                messageId: "suggestMoveToEntityFolder",
+                data: { dtoName },
+                fix: () => null, // Keine automatische Korrektur
+              },
+              {
+                messageId: "suggestRemoveFromEntityMethod",
+                data: { dtoName },
+                fix: (fixer) => {
+                  // Finde und entferne die fromEntityArray-Methode
+                  const fromEntityArrayMethod = node.body.body.find(member =>
+                    member.type === "MethodDefinition" &&
+                    member.static &&
+                    member.key?.name === "fromEntityArray"
+                  );
+
+                  if (fromEntityArrayMethod) {
+                    return fixer.remove(fromEntityArrayMethod);
+                  }
+                  return null;
+                },
+              },
+            ],
+          });
+        }
+      },
+
+      // Auch für export default class
+      ExportDefaultDeclaration(node) {
+        if (node.declaration.type !== "ClassDeclaration") {
+          return;
+        }
+
+        const filename = context.getFilename();
+        const dtoName = node.declaration.id?.name;
+
+        if (!dtoName || !dtoName.endsWith("Dto")) {
+          return; // Kein DTO
+        }
+
+        // Prüfe, ob die Datei im /dto/Entity/ Ordner liegt
+        const isInEntityFolder = filename.includes("/dto/Entity/");
+
+        if (isInEntityFolder) {
+          return; // Entity-DTOs dürfen fromEntity-Methoden haben
+        }
+
+        // Prüfe auf fromEntity und fromEntityArray Methoden
+        const hasFromEntity = node.declaration.body.body.some(member =>
+          member.type === "MethodDefinition" &&
+          member.static &&
+          member.key?.name === "fromEntity"
+        );
+
+        const hasFromEntityArray = node.declaration.body.body.some(member =>
+          member.type === "MethodDefinition" &&
+          member.static &&
+          member.key?.name === "fromEntityArray"
+        );
+
+        if (hasFromEntity) {
+          context.report({
+            node,
+            messageId: "forbiddenFromEntityOutsideEntityFolder",
+            data: {
+              dtoName,
+            },
+            suggest: [
+              {
+                messageId: "suggestMoveToEntityFolder",
+                data: { dtoName },
+                fix: () => null, // Keine automatische Korrektur
+              },
+              {
+                messageId: "suggestRemoveFromEntityMethod",
+                data: { dtoName },
+                fix: (fixer) => {
+                  // Finde und entferne die fromEntity-Methode
+                  const fromEntityMethod = node.declaration.body.body.find(member =>
+                    member.type === "MethodDefinition" &&
+                    member.static &&
+                    member.key?.name === "fromEntity"
+                  );
+
+                  if (fromEntityMethod) {
+                    return fixer.remove(fromEntityMethod);
+                  }
+                  return null;
+                },
+              },
+            ],
+          });
+        }
+
+        if (hasFromEntityArray) {
+          context.report({
+            node,
+            messageId: "forbiddenFromEntityArrayOutsideEntityFolder",
+            data: {
+              dtoName,
+            },
+            suggest: [
+              {
+                messageId: "suggestMoveToEntityFolder",
+                data: { dtoName },
+                fix: () => null, // Keine automatische Korrektur
+              },
+              {
+                messageId: "suggestRemoveFromEntityMethod",
+                data: { dtoName },
+                fix: (fixer) => {
+                  // Finde und entferne die fromEntityArray-Methode
+                  const fromEntityArrayMethod = node.declaration.body.body.find(member =>
+                    member.type === "MethodDefinition" &&
+                    member.static &&
+                    member.key?.name === "fromEntityArray"
+                  );
+
+                  if (fromEntityArrayMethod) {
+                    return fixer.remove(fromEntityArrayMethod);
+                  }
+                  return null;
+                },
+              },
+            ],
+          });
+        }
+      },
+    };
+  },
+};
+
+export default {
+  rules: {
+    "forbid-fromentity-outside-entity-folder": forbidFromEntityOutsideEntityFolderRule,
+  },
+};

package/rules/function-params-newline.js

@@ -0,0 +1,111 @@
+/**
+ * ESLint Custom Rule: function-params-newline
+ *
+ * Erzwingt Zeilenumbrüche bei Funktionsdeklarationen mit mehreren Parametern.
+ *
+ * Bei mehr als einem Parameter soll immer umgebrochen werden:
+ *
+ * ❌ Falsch:
+ * public async getAll (@Req() _req: Request, @Query() queryParams: ItemQueryRequestDto, @Res() res: Response): Promise<void> {
+ *
+ * ✅ Richtig:
+ * public async getAll (
+ *   @Req() _req: Request,
+ *   @Query() queryParams: ItemQueryRequestDto,
+ *   @Res() res: Response
+ * ): Promise<void> {
+ *
+ * Diese Regel gilt für:
+ * - Funktionsdeklarationen
+ * - Funktionsausdrücke
+ * - Arrow-Funktionen
+ * - Methoden in Klassen
+ */
+
+export default {
+  meta: {
+    type: "layout",
+    docs: {
+      description: "Erzwingt Zeilenumbrüche bei Funktionen mit mehreren Parametern",
+      category: "Stylistic Issues",
+      recommended: false,
+    },
+    fixable: "whitespace",
+    messages: {
+      missingNewline: "Bei mehr als einem Parameter soll jeder Parameter auf einer eigenen Zeile stehen",
+    },
+    schema: [],
+  },
+
+  create (context) {
+    const sourceCode = context.sourceCode ?? context.getSourceCode();
+
+    function checkParams (node) {
+      if (!node.params || node.params.length <= 1) {
+        return;
+      }
+
+      const firstParam = node.params[0];
+      const lastParam = node.params[node.params.length - 1];
+
+      const openParen = sourceCode.getTokenBefore(firstParam);
+      const closeParen = sourceCode.getTokenAfter(lastParam);
+
+      if (!openParen || !closeParen) {
+        return;
+      }
+
+      const firstParamLine = firstParam.loc.start.line;
+      const openParenLine = openParen.loc.end.line;
+
+      if (firstParamLine === openParenLine) {
+        const lastParamLine = lastParam.loc.end.line;
+
+        if (firstParamLine === lastParamLine) {
+          context.report({
+            node,
+            loc: {
+              start: openParen.loc.start,
+              end: closeParen.loc.end,
+            },
+            messageId: "missingNewline",
+            fix (fixer) {
+              const fixes = [];
+
+              fixes.push(fixer.insertTextAfter(openParen, "\n  "));
+
+              for (let index = 0; index < node.params.length - 1; index++) {
+                const param = node.params[index];
+                const comma = sourceCode.getTokenAfter(param);
+
+                if (comma && comma.value === ",") {
+                  fixes.push(fixer.insertTextAfter(comma, "\n  "));
+                }
+              }
+
+              fixes.push(fixer.insertTextBefore(closeParen, "\n"));
+
+              return fixes;
+            },
+          });
+        }
+      }
+    }
+
+    return {
+      FunctionDeclaration: checkParams,
+      FunctionExpression: checkParams,
+      ArrowFunctionExpression: checkParams,
+      MethodDefinition (node) {
+        if (node.value && node.value.params) {
+          checkParams(node.value);
+        }
+      },
+    };
+  },
+};
+
+
+
+
+

package/rules/imports.js

@@ -0,0 +1,264 @@
+export default {
+  rules: {
+    // Static analysis:
+
+    // ensure named imports coupled with named exports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/named.md#when-not-to-use-it
+    "import/named": "error",
+
+    // ensure default import coupled with default export
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/default.md#when-not-to-use-it
+    "import/default": "off",
+
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/namespace.md
+    "import/namespace": "off",
+
+    // Helpful warnings:
+
+    // disallow invalid exports, e.g. multiple defaults
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/export.md
+    "import/export": "error",
+
+    // do not allow a default import name to match a named export
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default.md
+    "import/no-named-as-default": "error",
+
+    // warn on accessing default export property names that are also named exports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default-member.md
+    "import/no-named-as-default-member": "error",
+
+    // disallow use of jsdoc-marked-deprecated imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md
+    "import/no-deprecated": "off",
+
+    // Forbid the use of extraneous packages
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md
+    // paths are treated both as absolute paths, and relative to process.cwd()
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        devDependencies: [
+          "test/**", // tape, common npm pattern
+          "tests/**", // also common npm pattern
+          "spec/**", // mocha, rspec-like pattern
+          "**/__tests__/**", // jest pattern
+          "**/__mocks__/**", // jest pattern
+          "test.{js,jsx}", // repos with a single test file
+          "test-*.{js,jsx}", // repos with multiple top-level test files
+          "**/*{.,_}{test,spec}.{js,jsx}", // tests where the extension or filename suffix denotes that it is a test
+          "**/jest.config.js", // jest config
+          "**/jest.setup.js", // jest setup
+          "**/vue.config.js", // vue-cli config
+          "**/webpack.config.js", // webpack config
+          "**/webpack.config.*.js", // webpack config
+          "**/rollup.config.js", // rollup config
+          "**/rollup.config.*.js", // rollup config
+          "**/gulpfile.js", // gulp config
+          "**/gulpfile.*.js", // gulp config
+          "**/Gruntfile{,.js}", // grunt config
+          "**/protractor.conf.js", // protractor config
+          "**/protractor.conf.*.js", // protractor config
+          "**/karma.conf.js", // karma config
+          "**/.eslintrc.js", // eslint config
+        ],
+        optionalDependencies: false,
+      },
+    ],
+
+    // Forbid mutable exports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md
+    "import/no-mutable-exports": "error",
+
+    // Module systems:
+
+    // disallow require()
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-commonjs.md
+    "import/no-commonjs": "off",
+
+    // disallow AMD require/define
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-amd.md
+    "import/no-amd": "error",
+
+    // No Node.js builtin modules
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-nodejs-modules.md
+    // TODO: enable?
+    "import/no-nodejs-modules": "off",
+
+    // Style guide:
+
+    // disallow non-import statements appearing before import statements
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/first.md
+    "import/first": "error",
+
+    // disallow non-import statements appearing before import statements
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/imports-first.md
+    // deprecated: use `import/first`
+    "import/imports-first": "off",
+
+    // disallow duplicate imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md
+    "import/no-duplicates": "error",
+
+    // disallow namespace imports
+    // TODO: enable?
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-namespace.md
+    "import/no-namespace": "off",
+
+    // Ensure consistent use of file extension within the import path
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md
+    "import/extensions": [
+      "error",
+      "never",
+      {
+        scss: "always"
+      }
+    ],
+
+    // ensure absolute imports are above relative imports and that unassigned imports are ignored
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md
+    // TODO: enforce a stricter convention in module import order?
+    "import/order": [
+      "error",
+      {
+        pathGroupsExcludedImportTypes: ["react"],
+        "newlines-between": "always",
+        alphabetize: {
+          order: "asc",
+          caseInsensitive: true,
+        },
+        groups: [
+          "builtin",
+          ["external", "internal"],
+          "parent",
+          "sibling",
+          "object",
+        ],
+      },
+    ],
+
+    // Require a newline after the last import/require in a group
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/newline-after-import.md
+    "import/newline-after-import": "error",
+
+    // Require modules with a single export to use a default export
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
+    "import/prefer-default-export": "error",
+
+    // Restrict which files can be imported in a given folder
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-restricted-paths.md
+    "import/no-restricted-paths": "off",
+
+    // Forbid modules to have too many dependencies
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/max-dependencies.md
+    "import/max-dependencies": ["off", { max: 10 }],
+
+    // Forbid import of modules using absolute paths
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-absolute-path.md
+    "import/no-absolute-path": "error",
+
+    // Forbid require() calls with expressions
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-dynamic-require.md
+    "import/no-dynamic-require": "error",
+
+    // prevent importing the submodules of other modules
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-internal-modules.md
+    "import/no-internal-modules": [
+      "off",
+      {
+        allow: [],
+      },
+    ],
+
+    // Warn if a module could be mistakenly parsed as a script by a consumer
+    // leveraging Unambiguous JavaScript Grammar
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/unambiguous.md
+    // this should not be enabled until this proposal has at least been *presented* to TC39.
+    // At the moment, it's not a thing.
+    "import/unambiguous": "off",
+
+    // Forbid Webpack loader syntax in imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md
+    "import/no-webpack-loader-syntax": "error",
+
+    // Prevent unassigned imports
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unassigned-import.md
+    // importing for side effects is perfectly acceptable, if you need side effects.
+    "import/no-unassigned-import": "off",
+
+    // Prevent importing the default as if it were named
+    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-default.md
+    "import/no-named-default": "error",
+
+    // Reports if a module's default export is unnamed
+    // https://github.com/benmosher/eslint-plugin-import/blob/d9b712ac7fd1fddc391f7b234827925c160d956f/docs/rules/no-anonymous-default-export.md
+    "import/no-anonymous-default-export": [
+      "off",
+      {
+        allowArray: false,
+        allowArrowFunction: false,
+        allowAnonymousClass: false,
+        allowAnonymousFunction: false,
+        allowLiteral: false,
+        allowObject: false,
+      },
+    ],
+
+    // This rule enforces that all exports are declared at the bottom of the file.
+    // https://github.com/benmosher/eslint-plugin-import/blob/98acd6afd04dcb6920b81330114e146dc8532ea4/docs/rules/exports-last.md
+    // TODO: enable?
+    "import/exports-last": "off",
+
+    // Reports when named exports are not grouped together in a single export declaration
+    // or when multiple assignments to CommonJS module.exports or exports object are present
+    // in a single file.
+    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/group-exports.md
+    "import/group-exports": "off",
+
+    // forbid default exports. this is a terrible rule, do not use it.
+    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-default-export.md
+    "import/no-default-export": "off",
+
+    // Prohibit named exports. this is a terrible rule, do not use it.
+    // https://github.com/benmosher/eslint-plugin-import/blob/1ec80fa35fa1819e2d35a70e68fb6a149fb57c5e/docs/rules/no-named-export.md
+    "import/no-named-export": "off",
+
+    // Forbid a module from importing itself
+    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-self-import.md
+    "import/no-self-import": "error",
+
+    // Forbid cyclical dependencies between modules
+    // https://github.com/benmosher/eslint-plugin-import/blob/d81f48a2506182738409805f5272eff4d77c9348/docs/rules/no-cycle.md
+    "import/no-cycle": ["error", { maxDepth: "∞" }],
+
+    // Ensures that there are no useless path segments
+    // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/no-useless-path-segments.md
+    "import/no-useless-path-segments": ["error", { commonjs: true }],
+
+    // dynamic imports require a leading comment with a webpackChunkName
+    // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/dynamic-import-chunkname.md
+    "import/dynamic-import-chunkname": [
+      "off",
+      {
+        importFunctions: [],
+        webpackChunknameFormat: "[0-9a-zA-Z-_/.]+",
+      },
+    ],
+
+    // Use this rule to prevent imports to folders in relative parent paths.
+    // https://github.com/benmosher/eslint-plugin-import/blob/c34f14f67f077acd5a61b3da9c0b0de298d20059/docs/rules/no-relative-parent-imports.md
+    "import/no-relative-parent-imports": "error",
+
+    // Reports the use of import declarations with CommonJS exports in any module except for the main module.
+    // https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-import-module-exports.md
+    "import/no-import-module-exports": [
+      "error",
+      {
+        exceptions: [],
+      },
+    ],
+
+    // Use this rule to prevent importing packages through relative paths.
+    // https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-relative-packages.md
+    "import/no-relative-packages": "error",
+  },
+};

package/rules/jest.js

@@ -0,0 +1,13 @@
+// Jest Rules
+export default {
+  rules: {
+    // eslint
+    "jest/consistent-test-it": [
+      "error",
+      {
+        fn: "test",
+        withinDescribe: "test",
+      },
+    ],
+  },
+};

package/rules/jsx.js

@@ -0,0 +1,16 @@
+export default {
+  rules: {
+    "jsx-a11y/anchor-is-valid": "error",
+    "jsx-a11y/no-noninteractive-element-interactions": "error",
+    "jsx-a11y/no-onchange": "off",
+    "jsx-a11y/no-static-element-interactions": "error",
+    "jsx-a11y/click-events-have-key-events": "off",
+    "jsx-a11y/mouse-events-have-key-events": "off",
+    "jsx-a11y/no-autofocus": "off",
+    "jsx-quotes": "error",
+    "jsx-a11y/alt-text": "error",
+    "jsx-a11y/img-redundant-alt": "error",
+    "jsx-a11y/aria-role": "error",
+    "jsx-a11y/no-access-key": "error",
+  },
+};