eslint-plugin-traceability 1.6.4 → 1.7.0

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

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const eslint_1 = require("eslint");
 const require_story_annotation_1 = __importDefault(require("../../src/rules/require-story-annotation"));
+const ts_language_options_1 = require("../utils/ts-language-options");
 const ruleTester = new eslint_1.RuleTester({
     languageOptions: {
         parserOptions: { ecmaVersion: 2020, sourceType: "module" },
@@ -36,30 +37,22 @@ function foo() {}`,
                 code: `// @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
 const arrowFn = () => {};`,
             },
-            {
+            (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-ANNOTATION-REQUIRED] valid on class method with annotation",
                 code: `class A {\n  /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\n  method() {}\n}`,
-            },
-            {
+            }),
+            (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-FUNCTION-DETECTION] valid with annotation on TS declare function",
                 code: `/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */
 declare function tsDecl(): void;`,
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2020, sourceType: "module" },
-                },
-            },
-            {
+            }),
+            (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-FUNCTION-DETECTION] valid with annotation on TS method signature",
                 code: `interface C {
   /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */
   method(): void;
 }`,
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2020, sourceType: "module" },
-                },
-            },
+            }),
             {
                 name: "[REQ-ANNOTATION-REQUIRED] unannotated arrow function allowed by default",
                 code: `const arrowFn = () => {};`,
@@ -98,7 +91,7 @@ declare function tsDecl(): void;`,
                     },
                 ],
             },
-            {
+            (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-ANNOTATION-REQUIRED] missing @story on class method",
                 code: `class C {\n  method() {}\n}`,
                 output: `class C {\n  /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\n  method() {}\n}`,
@@ -114,15 +107,11 @@ declare function tsDecl(): void;`,
                         ],
                     },
                 ],
-            },
-            {
+            }),
+            (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-ANNOTATION-REQUIRED] missing @story on TS declare function",
                 code: `declare function tsDecl(): void;`,
                 output: `/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\ndeclare function tsDecl(): void;`,
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2020, sourceType: "module" },
-                },
                 errors: [
                     {
                         messageId: "missingStory",
@@ -134,15 +123,11 @@ declare function tsDecl(): void;`,
                         ],
                     },
                 ],
-            },
-            {
+            }),
+            (0, ts_language_options_1.withTsLanguageOptions)({
                 name: "[REQ-ANNOTATION-REQUIRED] missing @story on TS method signature",
                 code: `interface D {\n  method(): void;\n}`,
                 output: `/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\ninterface D {\n  method(): void;\n}`,
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2020, sourceType: "module" },
-                },
                 errors: [
                     {
                         messageId: "missingStory",
@@ -154,7 +139,7 @@ declare function tsDecl(): void;`,
                         ],
                     },
                 ],
-            },
+            }),
         ],
     });
     ruleTester.run("require-story-annotation with exportPriority option", require_story_annotation_1.default, {

package/lib/tests/rules/require-story-core-edgecases.test.js

@@ -6,64 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * @req REQ-AUTOFIX - Cover additional branch cases in require-story-core (addStoryFixer/reportMissing)
  */
 const require_story_core_1 = require("../../src/rules/helpers/require-story-core");
-const require_story_helpers_1 = require("../../src/rules/helpers/require-story-helpers");
+const require_story_core_test_helpers_1 = require("../utils/require-story-core-test-helpers");
 describe("Require Story Core - edge cases (Story 003.0)", () => {
-    test("createAddStoryFix falls back to 0 when target is falsy", () => {
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const fixFn = (0, require_story_core_1.createAddStoryFix)(null);
-        const res = fixFn(fixer);
-        expect(fixer.insertTextBeforeRange).toHaveBeenCalledTimes(1);
-        const args = fixer.insertTextBeforeRange.mock.calls[0];
-        expect(args[0]).toEqual([0, 0]);
-        expect(args[1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
-        expect(res).toEqual({ r: [0, 0], t: `${require_story_helpers_1.ANNOTATION}\n` });
-    });
-    test("createAddStoryFix uses target.range when parent not export and parent.range missing", () => {
-        const target = {
-            type: "FunctionDeclaration",
-            range: [21, 33],
-            parent: { type: "ClassBody" },
-        };
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const fixFn = (0, require_story_core_1.createAddStoryFix)(target);
-        const res = fixFn(fixer);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([21, 21]);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
-        expect(res).toEqual({ r: [21, 21], t: `${require_story_helpers_1.ANNOTATION}\n` });
-    });
-    test("createAddStoryFix prefers ExportDefaultDeclaration parent.range when present", () => {
-        const target = {
-            type: "FunctionDeclaration",
-            range: [50, 70],
-            parent: { type: "ExportDefaultDeclaration", range: [5, 100] },
-        };
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const fixFn = (0, require_story_core_1.createAddStoryFix)(target);
-        const res = fixFn(fixer);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([5, 5]);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
-        expect(res).toEqual({ r: [5, 5], t: `${require_story_helpers_1.ANNOTATION}\n` });
-    });
-    test("reportMissing uses context.getSourceCode fallback when sourceCode not provided and still reports", () => {
-        const node = {
-            type: "FunctionDeclaration",
-            id: { name: "fnX" },
-            range: [0, 10],
-        };
-        const fakeSource = {
-            /* intentionally missing getJSDocComment to exercise branch */ getText: () => "",
-        };
-        const context = { getSourceCode: () => fakeSource, report: jest.fn() };
-        (0, require_story_core_1.reportMissing)(context, undefined, node, node);
-        expect(context.report).toHaveBeenCalledTimes(1);
-        const call = context.report.mock.calls[0][0];
-        expect(call.node).toBe(node);
-        expect(call.messageId).toBe("missingStory");
+    test("createAddStoryFix covers primary branch combinations via shared helper (edge cases)", () => {
+        (0, require_story_core_test_helpers_1.exerciseCreateAddStoryFixBranches)(require_story_core_1.createAddStoryFix);
     });
 });

package/lib/tests/rules/require-story-core.autofix.test.js

@@ -7,48 +7,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const require_story_core_1 = require("../../src/rules/helpers/require-story-core");
 const require_story_helpers_1 = require("../../src/rules/helpers/require-story-helpers");
+const require_story_core_test_helpers_1 = require("../utils/require-story-core-test-helpers");
 describe("Require Story Core (Story 003.0)", () => {
-    test("createAddStoryFix falls back to 0 when target is falsy", () => {
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const fixFn = (0, require_story_core_1.createAddStoryFix)(null);
-        const res = fixFn(fixer);
-        expect(fixer.insertTextBeforeRange).toHaveBeenCalledTimes(1);
-        const args = fixer.insertTextBeforeRange.mock.calls[0];
-        expect(args[0]).toEqual([0, 0]);
-        expect(args[1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
-        expect(res).toEqual({ r: [0, 0], t: `${require_story_helpers_1.ANNOTATION}\n` });
-    });
-    test("createAddStoryFix uses target.range when parent not export and parent.range missing", () => {
-        const target = {
-            type: "FunctionDeclaration",
-            range: [21, 33],
-            parent: { type: "ClassBody" },
-        };
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const fixFn = (0, require_story_core_1.createAddStoryFix)(target);
-        const res = fixFn(fixer);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([21, 21]);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
-        expect(res).toEqual({ r: [21, 21], t: `${require_story_helpers_1.ANNOTATION}\n` });
-    });
-    test("createAddStoryFix prefers ExportDefaultDeclaration parent.range when present", () => {
-        const target = {
-            type: "FunctionDeclaration",
-            range: [50, 70],
-            parent: { type: "ExportDefaultDeclaration", range: [5, 100] },
-        };
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const fixFn = (0, require_story_core_1.createAddStoryFix)(target);
-        const res = fixFn(fixer);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([5, 5]);
-        expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
-        expect(res).toEqual({ r: [5, 5], t: `${require_story_helpers_1.ANNOTATION}\n` });
+    test("createAddStoryFix covers primary branch combinations via shared helper", () => {
+        (0, require_story_core_test_helpers_1.exerciseCreateAddStoryFixBranches)(require_story_core_1.createAddStoryFix, {
+            annotationText: require_story_helpers_1.ANNOTATION + "\n",
+        });
     });
     test("reportMissing uses context.getSourceCode fallback when sourceCode not provided and still reports", () => {
         const node = {