eslint-plugin-traceability 1.4.10 → 1.4.11

package/lib/src/rules/helpers/require-story-core.js

@@ -68,7 +68,6 @@ function createMethodFix(node) {
 exports.DEFAULT_SCOPE = [
     "FunctionDeclaration",
     "FunctionExpression",
-    "ArrowFunctionExpression",
     "MethodDefinition",
     "TSMethodSignature",
     "TSDeclareFunction",

package/lib/src/rules/helpers/require-story-helpers.js

@@ -252,8 +252,11 @@ function reportMissing(context, sourceCode, node, passedTarget) {
         }
         const resolvedTarget = passedTarget ?? resolveTargetNode(sourceCode, node);
         const name = functionName;
+        const nameNode = (node.id && node.id.type === "Identifier" && node.id) ||
+            (node.key && node.key.type === "Identifier" && node.key) ||
+            node;
         context.report({
-            node,
+            node: nameNode,
             messageId: "missingStory",
             data: { name },
             suggest: [
@@ -285,8 +288,9 @@ function reportMethod(context, sourceCode, node, passedTarget) {
         }
         const resolvedTarget = passedTarget ?? resolveTargetNode(sourceCode, node);
         const name = extractName(node);
+        const nameNode = (node.key && node.key.type === "Identifier" && node.key) || node;
         context.report({
-            node,
+            node: nameNode,
             messageId: "missingStory",
             data: { name },
             suggest: [

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

@@ -17,7 +17,7 @@ const rule = {
         },
         hasSuggestions: true,
         messages: {
-            missingStory: "Missing @story annotation (REQ-ANNOTATION-REQUIRED)",
+            missingStory: "Missing @story annotation for function '{{name}}' (REQ-ANNOTATION-REQUIRED)",
         },
         schema: [
             {

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

@@ -60,6 +60,10 @@ declare function tsDecl(): void;`,
                     parserOptions: { ecmaVersion: 2020, sourceType: "module" },
                 },
             },
+            {
+                name: "[REQ-ANNOTATION-REQUIRED] unannotated arrow function allowed by default",
+                code: `const arrowFn = () => {};`,
+            },
         ],
         invalid: [
             {
@@ -92,21 +96,6 @@ declare function tsDecl(): void;`,
                     },
                 ],
             },
-            {
-                name: "[REQ-ANNOTATION-REQUIRED] missing @story on arrow function",
-                code: `const arrowFn = () => {};`,
-                errors: [
-                    {
-                        messageId: "missingStory",
-                        suggestions: [
-                            {
-                                desc: `Add JSDoc @story annotation for function 'arrowFn', e.g., /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */`,
-                                output: `/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\nconst arrowFn = () => {};`,
-                            },
-                        ],
-                    },
-                ],
-            },
             {
                 name: "[REQ-ANNOTATION-REQUIRED] missing @story on class method",
                 code: `class C {\n  method() {}\n}`,
@@ -174,6 +163,11 @@ declare function tsDecl(): void;`,
                 code: `// @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md\nexport function exportedAnnotated() {}`,
                 options: [{ exportPriority: "exported" }],
             },
+            {
+                name: "[exportPriority] exported arrow function missing @story annotation",
+                code: `export const arrowExported = () => {};`,
+                options: [{ exportPriority: "exported" }],
+            },
         ],
         invalid: [
             {
@@ -192,22 +186,6 @@ declare function tsDecl(): void;`,
                     },
                 ],
             },
-            {
-                name: "[exportPriority] exported arrow function missing @story annotation",
-                code: `export const arrowExported = () => {};`,
-                options: [{ exportPriority: "exported" }],
-                errors: [
-                    {
-                        messageId: "missingStory",
-                        suggestions: [
-                            {
-                                desc: `Add JSDoc @story annotation for function 'arrowExported', e.g., /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */`,
-                                output: `/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\nexport const arrowExported = () => {};`,
-                            },
-                        ],
-                    },
-                ],
-            },
         ],
     });
     ruleTester.run("require-story-annotation with scope option", require_story_annotation_1.default, {

package/lib/tests/rules/valid-story-reference.test.js

@@ -123,6 +123,42 @@ describe("Valid Story Reference Rule Error Handling (Story 006.0-DEV-FILE-VALIDA
         expect(() => (0, storyReferenceUtils_1.storyExists)(["docs/stories/permission-denied.story.md"])).not.toThrow();
         expect((0, storyReferenceUtils_1.storyExists)(["docs/stories/permission-denied.story.md"])).toBe(false);
     });
+    /**
+     * @req REQ-ERROR-HANDLING - Verify storyExists handles EIO from fs.statSync
+     * by returning false and not throwing when fs.existsSync returns true.
+     * @story docs/stories/006.0-DEV-FILE-VALIDATION.story.md
+     */
+    it("[REQ-ERROR-HANDLING] storyExists returns false when fs.statSync throws EIO and existsSync is true", () => {
+        jest.spyOn(fs, "existsSync").mockImplementation(() => true);
+        jest.spyOn(fs, "statSync").mockImplementation(() => {
+            const err = new Error("EIO: i/o error while reading file");
+            err.code = "EIO";
+            throw err;
+        });
+        expect(() => (0, storyReferenceUtils_1.storyExists)(["docs/stories/io-error.story.md"])).not.toThrow();
+        expect((0, storyReferenceUtils_1.storyExists)(["docs/stories/io-error.story.md"])).toBe(false);
+    });
+    /**
+     * @req REQ-ERROR-HANDLING - Verify rule reports fileAccessError when fs.statSync throws
+     * and fs.existsSync returns true, treating it as a filesystem access problem
+     * rather than a missing file.
+     * @story docs/stories/006.0-DEV-FILE-VALIDATION.story.md
+     */
+    it("[REQ-ERROR-HANDLING] rule reports fileAccessError when fs.statSync throws and existsSync is true", () => {
+        const accessError = new Error("EIO: i/o error while reading file metadata");
+        accessError.code = "EIO";
+        jest.spyOn(fs, "existsSync").mockImplementation(() => true);
+        jest.spyOn(fs, "statSync").mockImplementation(() => {
+            throw accessError;
+        });
+        const diagnostics = runRuleOnCode(`// @story docs/stories/fs-stat-io-error.story.md`);
+        expect(diagnostics.length).toBeGreaterThan(0);
+        const fileAccessDiagnostics = diagnostics.filter((d) => d.messageId === "fileAccessError");
+        expect(fileAccessDiagnostics.length).toBeGreaterThan(0);
+        const errorData = fileAccessDiagnostics[0].data;
+        expect(errorData).toBeDefined();
+        expect(String(errorData.error)).toMatch(/EIO/i);
+    });
     /**
      * @req REQ-ERROR-HANDLING - Verify rule reports fileAccessError when filesystem operations fail
      * instead of treating it as a missing file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.4.10",
+  "version": "1.4.11",
   "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",