eslint-plugin-traceability 1.23.0 → 1.24.0

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Tests for: docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-AUTOFIX - Cover additional branch cases in require-story-core (addStoryFixer/reportMissing)
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-AUTOFIX
- * @supports docs/stories/007.0-DEV-ERROR-REPORTING.story.md REQ-ERROR-RESILIENCE
- */
-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 covers primary branch combinations via shared helper", () => {
-        const defaultTemplate = (0, require_story_helpers_1.getAnnotationTemplate)();
-        const factory = (target, _annotationTemplate) => (0, require_story_core_1.createAddStoryFix)(target, defaultTemplate);
-        (0, require_story_core_test_helpers_1.exerciseCreateAddStoryFixBranches)(factory, {
-            annotationText: defaultTemplate,
-        });
-    });
-    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_helpers_1.reportMissing)(context, undefined, {
-            node,
-            target: node,
-            options: { autoFixToggle: true },
-        });
-        expect(context.report).toHaveBeenCalledTimes(1);
-        const call = context.report.mock.calls[0][0];
-        expect(call.node).toBe(node);
-        expect(call.messageId).toBe("missingStory");
-    });
-    test("coreReportMissing swallows dependency errors and does not break lint run", () => {
-        const deps = {
-            hasStoryAnnotation: () => {
-                throw new Error("boom");
-            },
-            getReportedFunctionName: () => "fnX",
-            resolveAnnotationTargetNode: () => ({ type: "FunctionDeclaration" }),
-            getNameNodeForReport: (node) => node,
-            buildTemplateConfig: () => ({
-                effectiveTemplate: "/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */",
-                allowFix: true,
-            }),
-            extractName: () => "fnX",
-            getAnnotationTemplate: () => "/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */",
-            shouldApplyAutoFix: () => true,
-            createAddStoryFix: () => () => ({}),
-            createMethodFix: () => () => ({}),
-        };
-        const context = {
-            report: jest.fn(),
-        };
-        const node = { type: "FunctionDeclaration" };
-        expect(() => (0, require_story_core_1.coreReportMissing)(deps, context, {}, { node })).not.toThrow();
-        expect(context.report).not.toHaveBeenCalled();
-    });
-});

package/lib/tests/rules/require-story-core.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Tests for: docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-AUTOFIX - Verify createMethodFix and reportMethod behaviors
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-AUTOFIX
- */
-const require_story_core_1 = require("../../src/rules/helpers/require-story-core");
-const require_story_helpers_1 = require("../../src/rules/helpers/require-story-helpers");
-describe("Require Story Core (Story 003.0)", () => {
-    test("createMethodFix uses parent range start when parent is export", () => {
-        const node = {
-            type: "MethodDefinition",
-            range: [30, 60],
-            parent: { type: "ExportNamedDeclaration", range: [12, 90] },
-        };
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const defaultTemplate = (0, require_story_helpers_1.getAnnotationTemplate)();
-        const fixFn = (0, require_story_core_1.createMethodFix)(node, defaultTemplate);
-        const result = fixFn(fixer);
-        expect(fixer.insertTextBeforeRange).toHaveBeenCalledTimes(1);
-        const calledArgs = fixer.insertTextBeforeRange.mock.calls[0];
-        expect(calledArgs[0]).toEqual([12, 12]);
-        expect(typeof calledArgs[1]).toBe("string");
-        expect(calledArgs[1].length).toBeGreaterThan(0);
-        expect(result).toEqual({ r: [12, 12], t: calledArgs[1] });
-    });
-    test("reportMethod calls context.report with proper data and suggest.fix works", () => {
-        const node = {
-            type: "MethodDefinition",
-            key: { name: "myMethod" },
-            range: [40, 80],
-            parent: { type: "ClassBody" },
-        };
-        const fakeSource = { getText: () => "" };
-        const context = {
-            getSourceCode: () => fakeSource,
-            report: jest.fn(),
-        };
-        (0, require_story_helpers_1.reportMethod)(context, fakeSource, { node, target: node });
-        expect(context.report).toHaveBeenCalledTimes(1);
-        const call = context.report.mock.calls[0][0];
-        expect(call.messageId).toBe("missingStory");
-        expect(call.data).toHaveProperty("name");
-        expect(call.data).toHaveProperty("functionName");
-        expect(typeof call.data.name).toBe("string");
-        expect(typeof call.data.functionName).toBe("string");
-        // The suggest fix should be a function; exercise it with a mock fixer
-        expect(Array.isArray(call.suggest)).toBe(true);
-        expect(typeof call.suggest[0].fix).toBe("function");
-        const fixer = {
-            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
-        };
-        const fixResult = call.suggest[0].fix(fixer);
-        expect(fixer.insertTextBeforeRange).toHaveBeenCalled();
-        const args = fixer.insertTextBeforeRange.mock.calls[0];
-        expect(args[0]).toEqual([40, 40]);
-        expect(typeof args[1]).toBe("string");
-        expect(args[1].length).toBeGreaterThan(0);
-        expect(fixResult).toEqual({ r: [40, 40], t: args[1] });
-    });
-});

package/lib/tests/rules/require-story-helpers-edgecases.test.d.ts

@@ -1,7 +0,0 @@
-/**
- * Tests for: docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-HELPERS-EDGE-CASES - Edge-case behavior tests for helpers in require-story-helpers.ts
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-HELPERS-EDGE-CASES
- */
-export {};

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

@@ -1,80 +0,0 @@
-"use strict";
-/**
- * Tests for: docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-HELPERS-EDGE-CASES - Edge-case behavior tests for helpers in require-story-helpers.ts
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-HELPERS-EDGE-CASES
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const require_story_helpers_1 = require("../../src/rules/helpers/require-story-helpers");
-describe("Require Story Helpers - edge cases (Story 003.0)", () => {
-    test("jsdocHasStory returns false when JSDoc exists but value is not a string", () => {
-        const fakeSource = { getJSDocComment: () => ({ value: 123 }) };
-        const res = (0, require_story_helpers_1.jsdocHasStory)(fakeSource, {});
-        expect(res).toBe(false);
-    });
-    test("commentsBeforeHasStory returns false when comments exist but value is not a string", () => {
-        const fakeSource = { getCommentsBefore: () => [{ value: 123 }] };
-        const res = (0, require_story_helpers_1.commentsBeforeHasStory)(fakeSource, {});
-        expect(res).toBe(false);
-    });
-    test("leadingCommentsHasStory detects @story in leadingComments array", () => {
-        const node = {
-            leadingComments: [
-                { type: "Block", value: "some other text" },
-                {
-                    type: "Block",
-                    value: "@story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md",
-                },
-            ],
-        };
-        expect((0, require_story_helpers_1.leadingCommentsHasStory)(node)).toBe(true);
-    });
-    test("resolveTargetNode returns ExpressionStatement parent for FunctionExpression", () => {
-        const fakeSource = { getText: () => "" };
-        const node = {
-            type: "FunctionExpression",
-            parent: { type: "ExpressionStatement" },
-        };
-        const resolved = (0, require_story_helpers_1.resolveTargetNode)(fakeSource, node);
-        expect(resolved).toBe(node.parent);
-    });
-    test("shouldProcessNode respects exportPriority 'exported' and 'non-exported'", () => {
-        const exportedNode = {
-            type: "FunctionDeclaration",
-            parent: { parent: { type: "ExportNamedDeclaration" } },
-        };
-        const nonExportedNode = {
-            type: "FunctionDeclaration",
-            parent: { parent: { type: "SomeOther" } },
-        };
-        expect((0, require_story_helpers_1.shouldProcessNode)(exportedNode, require_story_helpers_1.DEFAULT_SCOPE, "exported")).toBe(true);
-        expect((0, require_story_helpers_1.shouldProcessNode)(nonExportedNode, require_story_helpers_1.DEFAULT_SCOPE, "exported")).toBe(false);
-        // non-exported should reject exported nodes
-        expect((0, require_story_helpers_1.shouldProcessNode)(exportedNode, require_story_helpers_1.DEFAULT_SCOPE, "non-exported")).toBe(false);
-        expect((0, require_story_helpers_1.shouldProcessNode)(nonExportedNode, require_story_helpers_1.DEFAULT_SCOPE, "non-exported")).toBe(true);
-    });
-    test("reportMissing does not report when linesBeforeHasStory finds a preceding @story", () => {
-        const jsdoc = "/**\n * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md\n */\n";
-        const rest = "function fnA() {}\n";
-        const full = jsdoc + rest;
-        const fakeSource = {
-            getText: () => full,
-            getJSDocComment: () => null,
-            lines: full.split(/\r?\n/),
-            getCommentsBefore: () => [],
-        };
-        const node = {
-            type: "FunctionDeclaration",
-            range: [full.indexOf("function"), full.length],
-            loc: {
-                start: {
-                    line: fakeSource.lines.findIndex((l) => l.includes("function fnA() {}")) + 1,
-                },
-            },
-        };
-        const context = { getSourceCode: () => fakeSource, report: jest.fn() };
-        (0, require_story_helpers_1.reportMissing)(context, fakeSource, { node, target: node });
-        expect(context.report).not.toHaveBeenCalled();
-    });
-});

package/lib/tests/rules/require-story-helpers.test.d.ts

@@ -1 +0,0 @@
-export {};