eslint-plugin-traceability 1.22.0 → 1.23.0

package/CHANGELOG.md

@@ -1,14 +1,9 @@
-# [1.22.0](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.21.1...v1.22.0) (2026-01-10)
-
-
-### Bug Fixes
-
-* move voder-ai to optionalDependencies to allow CI without GitHub Packages access ([1a674cb](https://github.com/voder-ai/eslint-plugin-traceability/commit/1a674cb65d5223c75710910817393667435bfcd8))
+# [1.23.0](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.22.0...v1.23.0) (2026-01-10)
 
 
 ### Features
 
-* **ci:** add post-deployment verification step ([00d3d21](https://github.com/voder-ai/eslint-plugin-traceability/commit/00d3d214f21e18bfc26e3de4fbcb0bd9f0aa8f28))
+* **rules:** add ArrowFunctionExpression support to require-req-annotation ([92d2e60](https://github.com/voder-ai/eslint-plugin-traceability/commit/92d2e60686c661faa58c41fd533e7d9e6acbae18))
 
 # Changelog
 

package/lib/src/rules/require-req-annotation.js

@@ -2,6 +2,56 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const require_story_helpers_1 = require("./helpers/require-story-helpers");
 const annotation_checker_1 = require("../utils/annotation-checker");
+/**
+ * Build visitor handlers for require-req-annotation rule.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-FUNCTION-DETECTION - Provide visitor construction for all function types
+ */
+function buildReqAnnotationVisitors(runCheck) {
+    return {
+        /**
+         * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+         * @req REQ-FUNCTION-DETECTION - Detect function declarations
+         * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on function declarations
+         */
+        FunctionDeclaration: runCheck,
+        /**
+         * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+         * @req REQ-FUNCTION-DETECTION - Detect function expressions
+         * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on function expressions
+         */
+        FunctionExpression(node) {
+            if (node.parent && node.parent.type === "MethodDefinition") {
+                return;
+            }
+            runCheck(node);
+        },
+        /**
+         * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+         * @req REQ-FUNCTION-DETECTION - Detect arrow function expressions
+         * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on arrow function expressions
+         */
+        ArrowFunctionExpression: runCheck,
+        /**
+         * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+         * @req REQ-FUNCTION-DETECTION - Detect method definitions
+         * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on method definitions
+         */
+        MethodDefinition: runCheck,
+        /**
+         * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+         * @req REQ-TYPESCRIPT-SUPPORT - Support TypeScript declare functions
+         * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on TS declare functions
+         */
+        TSDeclareFunction: runCheck,
+        /**
+         * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+         * @req REQ-TYPESCRIPT-SUPPORT - Support TypeScript method signatures
+         * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on TS method signatures
+         */
+        TSMethodSignature: runCheck,
+    };
+}
 const rule = {
     meta: {
         type: "problem",
@@ -78,51 +128,7 @@ const rule = {
                 annotationPlacement,
             });
         };
-        return {
-            /**
-             * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-             * @req REQ-FUNCTION-DETECTION - Detect function declarations
-             * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on function declarations
-             */
-            FunctionDeclaration(node) {
-                runCheck(node);
-            },
-            /**
-             * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-             * @req REQ-FUNCTION-DETECTION - Detect function expressions
-             * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on function expressions
-             */
-            FunctionExpression(node) {
-                if (node.parent && node.parent.type === "MethodDefinition") {
-                    return;
-                }
-                runCheck(node);
-            },
-            /**
-             * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-             * @req REQ-FUNCTION-DETECTION - Detect method definitions
-             * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on method definitions
-             */
-            MethodDefinition(node) {
-                runCheck(node);
-            },
-            /**
-             * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-             * @req REQ-TYPESCRIPT-SUPPORT - Support TypeScript declare functions
-             * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on TS declare functions
-             */
-            TSDeclareFunction(node) {
-                runCheck(node);
-            },
-            /**
-             * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-             * @req REQ-TYPESCRIPT-SUPPORT - Support TypeScript method signatures
-             * @req REQ-ANNOTATION-REQUIRED - Enforce @req annotation on TS method signatures
-             */
-            TSMethodSignature(node) {
-                runCheck(node);
-            },
-        };
+        return buildReqAnnotationVisitors(runCheck);
     },
 };
 exports.default = rule;

package/lib/tests/rules/require-req-annotation.test.js

@@ -94,6 +94,14 @@ describe("Require Req Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", (
                 name: "[REQ-FUNCTION-DETECTION][Story 003.0] valid MethodDefinition with @req annotation",
                 code: `class C {\n  /**\n   * @req REQ-EXAMPLE\n   */\n  m() {}\n}`,
             },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] valid ArrowFunctionExpression with @req annotation",
+                code: `/** @req REQ-EXAMPLE */\nconst arrow = () => {};`,
+            },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] valid exported ArrowFunctionExpression with @req annotation",
+                code: `/** @req REQ-EXAMPLE */\nexport const arrow = () => {};`,
+            },
             (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-TYPESCRIPT-SUPPORT][REQ-FUNCTION-DETECTION][Story 003.0] valid TS FunctionExpression in variable declarator with @req",
                 code: `const fn = /**\n * @req REQ-EXAMPLE\n */\nfunction () {};`,
@@ -189,6 +197,16 @@ describe("Require Req Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", (
                 code: `const o = { m() {} };`,
                 errors: [missingReq("m")],
             },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] missing @req on ArrowFunctionExpression",
+                code: `const arrow = () => {};`,
+                errors: [missingReq("arrow")],
+            },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] missing @req on exported ArrowFunctionExpression",
+                code: `export const arrow = () => {};`,
+                errors: [missingReq("arrow")],
+            },
             (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-TYPESCRIPT-SUPPORT][REQ-FUNCTION-DETECTION][Story 003.0] missing @req on TS FunctionExpression in variable declarator",
                 code: `const fn = function () {};`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.22.0",
+  "version": "1.23.0",
   "description": "A customizable ESLint plugin that enforces traceability annotations in your code, ensuring each implementation is linked to its requirement or test case.",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",
@@ -51,8 +51,7 @@
     "debug:require-story": "node scripts/debug-require-story.js",
     "debug:repro": "node scripts/debug-repro.js",
     "report:eslint-suppressions": "node scripts/report-eslint-suppressions.js",
-    "check:scripts": "node scripts/validate-scripts-nonempty.js",
-    "voder": "voder --help"
+    "check:scripts": "node scripts/validate-scripts-nonempty.js"
   },
   "lint-staged": {
     "src/**/*.{js,jsx,ts,tsx,json,md}": [
@@ -100,9 +99,6 @@
     "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   },
-  "optionalDependencies": {
-    "@voder-ai/voder-ai": "^5.6.1"
-  },
   "peerDependencies": {
     "eslint": "^9.0.0"
   },

package/user-docs/api-reference.md

@@ -63,13 +63,13 @@ Among the supported scopes, anonymous callbacks passed directly to common test f
 
 ### traceability/require-req-annotation
 
-Description: **Legacy function-level key:** This rule key is retained for backward compatibility and conceptually composes the same checks as `traceability/require-traceability`. New configurations should normally enable `traceability/require-traceability` instead and rely on this key only when you need to tune it independently. Ensures that function-like constructs consistently declare their linked requirements via traceability annotations, preferring `@supports` when possible while still accepting `@req`. The rule targets the same function-like node types as `traceability/require-story-annotation` (standard function declarations, non-arrow function expressions used as callbacks or assignments, class/object methods, TypeScript declare functions, and interface method signatures), and enforces that each of them has at least one `@req` tag in the nearest associated JSDoc comment. When you adopt multi-story `@supports` annotations, this rule also treats `@supports story-path REQ-ID...` tags as satisfying the requirement coverage check, although deep verification of requirement IDs continues to be handled by `traceability/valid-req-reference`. Arrow functions (`ArrowFunctionExpression`) are not currently checked by this rule.
+Description: **Legacy function-level key:** This rule key is retained for backward compatibility and conceptually composes the same checks as `traceability/require-traceability`. New configurations should normally enable `traceability/require-traceability` instead and rely on this key only when you need to tune it independently. Ensures that function-like constructs consistently declare their linked requirements via traceability annotations, preferring `@supports` when possible while still accepting `@req`. The rule targets the same function-like node types as `traceability/require-story-annotation` (standard function declarations, function expressions, arrow functions, class/object methods, TypeScript declare functions, and interface method signatures), and enforces that each of them has at least one `@req` tag in the nearest associated JSDoc comment. When you adopt multi-story `@supports` annotations, this rule also treats `@supports story-path REQ-ID...` tags as satisfying the requirement coverage check, although deep verification of requirement IDs continues to be handled by `traceability/valid-req-reference`.
 
 This rule is typically used alongside `traceability/require-story-annotation` so that each function-level traceability block includes both an `@story` and an `@req` annotation, but it can also be enabled independently if you only want to enforce requirement linkage. Unlike `traceability/require-story-annotation`, this rule does not currently provide an auto-fix mode for inserting placeholder `@req` annotations; it only reports missing or malformed requirement annotations on the configured scopes.
 
 Options:
 
-- `scope` (string[], optional) – Controls which function-like node types are required to have @req annotations. Allowed values: "FunctionDeclaration", "FunctionExpression", "MethodDefinition", "TSDeclareFunction", "TSMethodSignature". Default: ["FunctionDeclaration", "FunctionExpression", "MethodDefinition", "TSDeclareFunction", "TSMethodSignature"].
+- `scope` (string[], optional) – Controls which function-like node types are required to have @req annotations. Allowed values: "FunctionDeclaration", "FunctionExpression", "ArrowFunctionExpression", "MethodDefinition", "TSDeclareFunction", "TSMethodSignature". Default: ["FunctionDeclaration", "FunctionExpression", "ArrowFunctionExpression", "MethodDefinition", "TSDeclareFunction", "TSMethodSignature"].
 - `exportPriority` ("all" | "exported" | "non-exported", optional) – Controls whether the rule checks all functions, only exported ones, or only non-exported ones. Default: "all".
 - `annotationPlacement` ("before" | "inside", optional)  Controls whether the rule treats before-function comments as the source of annotations (`"before"`, the default and backward-compatible behavior) or instead requires annotations as the first comment-only lines inside function and method bodies (`"inside"`). In `"inside"` mode, JSDoc and before-function comments are ignored for block-bodied functions and methods, and only inside-body comments are considered; declaration-only nodes (e.g., TS signatures) continue to use before-node annotations.