eslint-plugin-traceability 1.23.0 → 1.24.0

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

@@ -1,158 +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-ANNOTATION-REQUIRED - Verify getNodeName resolves names for diverse AST node shapes
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ANNOTATION-REQUIRED
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const require_story_utils_1 = require("../../src/rules/helpers/require-story-utils");
-describe("Require Story Utils - getNodeName (Story 003.0)", () => {
-    it("[REQ-ANNOTATION-REQUIRED] returns identifier name for Identifier and JSXIdentifier", () => {
-        const idNode = { type: "Identifier", name: "foo" };
-        const jsxIdNode = { type: "JSXIdentifier", name: "Bar" };
-        expect((0, require_story_utils_1.getNodeName)(idNode)).toBe("foo");
-        expect((0, require_story_utils_1.getNodeName)(jsxIdNode)).toBe("Bar");
-    });
-    it("[REQ-ANNOTATION-REQUIRED] returns null for identifier-like nodes without string name", () => {
-        const badId = { type: "Identifier", name: 123 };
-        const badJsxId = { type: "JSXIdentifier", name: null };
-        expect((0, require_story_utils_1.getNodeName)(badId)).toBeNull();
-        expect((0, require_story_utils_1.getNodeName)(badJsxId)).toBeNull();
-    });
-    it("[REQ-ANNOTATION-REQUIRED] converts simple Literal values into string names", () => {
-        const stringLit = { type: "Literal", value: "name" };
-        const numberLit = { type: "Literal", value: 42 };
-        const boolLit = { type: "Literal", value: true };
-        const nullLit = { type: "Literal", value: null };
-        const objLit = { type: "Literal", value: { a: 1 } };
-        expect((0, require_story_utils_1.getNodeName)(stringLit)).toBe("name");
-        expect((0, require_story_utils_1.getNodeName)(numberLit)).toBe("42");
-        expect((0, require_story_utils_1.getNodeName)(boolLit)).toBe("true");
-        expect((0, require_story_utils_1.getNodeName)(nullLit)).toBeNull();
-        expect((0, require_story_utils_1.getNodeName)(objLit)).toBeNull();
-    });
-    it("[REQ-ANNOTATION-REQUIRED] resolves simple, expression-free TemplateLiteral names", () => {
-        const tplNode = {
-            type: "TemplateLiteral",
-            expressions: [],
-            quasis: [
-                { value: { cooked: "hello", raw: "hello" } },
-                { value: { cooked: "-world", raw: "-world" } },
-            ],
-        };
-        const withExpressions = {
-            type: "TemplateLiteral",
-            expressions: [{}],
-            quasis: [{ value: { cooked: "ignored", raw: "ignored" } }],
-        };
-        expect((0, require_story_utils_1.getNodeName)(tplNode)).toBe("hello-world");
-        expect((0, require_story_utils_1.getNodeName)(withExpressions)).toBeNull();
-    });
-    it("[REQ-ANNOTATION-REQUIRED] resolves non-computed member/qualified names and rejects computed", () => {
-        const memberExpr = {
-            type: "MemberExpression",
-            object: { type: "Identifier", name: "obj" },
-            property: { type: "Identifier", name: "prop" },
-            computed: false,
-        };
-        const computedMember = {
-            type: "MemberExpression",
-            object: { type: "Identifier", name: "obj" },
-            property: { type: "Literal", value: "dynamic" },
-            computed: true,
-        };
-        const tsQualified = {
-            type: "TSQualifiedName",
-            left: { type: "Identifier", name: "Ns" },
-            right: { type: "Identifier", name: "Type" },
-        };
-        const jsxMember = {
-            type: "JSXMemberExpression",
-            object: { type: "JSXIdentifier", name: "Ns" },
-            property: { type: "JSXIdentifier", name: "Component" },
-        };
-        expect((0, require_story_utils_1.getNodeName)(memberExpr)).toBe("prop");
-        expect((0, require_story_utils_1.getNodeName)(computedMember)).toBeNull();
-        expect((0, require_story_utils_1.getNodeName)(tsQualified)).toBe("Type");
-        expect((0, require_story_utils_1.getNodeName)(jsxMember)).toBe("Component");
-    });
-    it("[REQ-ANNOTATION-REQUIRED] extracts names from Property/ObjectProperty keys", () => {
-        const prop = {
-            type: "Property",
-            key: { type: "Identifier", name: "propName" },
-        };
-        const objProp = {
-            type: "ObjectProperty",
-            key: { type: "Literal", value: "literalKey" },
-        };
-        const notProp = { type: "MethodDefinition", key: { name: "method" } };
-        expect((0, require_story_utils_1.getNodeName)(prop)).toBe("propName");
-        expect((0, require_story_utils_1.getNodeName)(objProp)).toBe("literalKey");
-        expect((0, require_story_utils_1.getNodeName)(notProp)).toBe("method");
-    });
-    it("[REQ-ANNOTATION-REQUIRED] prefers direct id/key names before deeper inspection", () => {
-        const funcNode = {
-            type: "FunctionDeclaration",
-            id: { type: "Identifier", name: "directName" },
-            key: { type: "Identifier", name: "ignored" },
-        };
-        const keyNode = {
-            type: "MethodDefinition",
-            key: { type: "Identifier", name: "keyName" },
-        };
-        expect((0, require_story_utils_1.getNodeName)(funcNode)).toBe("directName");
-        expect((0, require_story_utils_1.getNodeName)(keyNode)).toBe("keyName");
-    });
-    it("[REQ-ANNOTATION-REQUIRED] unwraps TSLiteralType and JSXNamespacedName wrappers", () => {
-        const tsLiteral = {
-            type: "TSLiteralType",
-            literal: { type: "Literal", value: "wrapped" },
-        };
-        const jsxNamespaced = {
-            type: "JSXNamespacedName",
-            name: { type: "JSXIdentifier", name: "NsComponent" },
-        };
-        expect((0, require_story_utils_1.getNodeName)(tsLiteral)).toBe("wrapped");
-        expect((0, require_story_utils_1.getNodeName)(jsxNamespaced)).toBe("NsComponent");
-    });
-    it("[REQ-ANNOTATION-REQUIRED] returns null for non-TemplateLiteral nodes passed to templateLiteralToString via getNodeName", () => {
-        const fakeTemplate = {
-            type: "Literal",
-            value: "no-template",
-            quasis: [{ value: { cooked: "ignored", raw: "ignored" } }],
-        };
-        const realTemplateWithExpr = {
-            type: "TemplateLiteral",
-            expressions: [{ type: "Identifier", name: "expr" }],
-            quasis: [{ value: { cooked: "start", raw: "start" } }],
-        };
-        expect((0, require_story_utils_1.getNodeName)(fakeTemplate)).toBe("no-template");
-        expect((0, require_story_utils_1.getNodeName)(realTemplateWithExpr)).toBeNull();
-    });
-    it("[REQ-ANNOTATION-REQUIRED] handles nullish and missing .value in TemplateLiteral quasis defensively", () => {
-        const defensiveTemplate = {
-            type: "TemplateLiteral",
-            expressions: [],
-            quasis: [
-                null,
-                { value: null },
-                { value: { cooked: "part1", raw: "raw1" } },
-                { value: { raw: "-only-raw" } },
-                {},
-            ],
-        };
-        expect((0, require_story_utils_1.getNodeName)(defensiveTemplate)).toBe("part1-only-raw");
-    });
-    it("[REQ-ANNOTATION-REQUIRED] follows generic .key fallback for other shapes", () => {
-        const genericWithKey = {
-            type: "SomeNode",
-            key: { type: "Identifier", name: "viaKey" },
-        };
-        const genericWithoutKey = {
-            type: "SomeNode",
-        };
-        expect((0, require_story_utils_1.getNodeName)(genericWithKey)).toBe("viaKey");
-        expect((0, require_story_utils_1.getNodeName)(genericWithoutKey)).toBeNull();
-    });
-});

package/lib/tests/rules/require-story-visitors-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-VISITORS-BEHAVIOR - Behavior tests for visitors in require-story-visitors.ts
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-VISITORS-BEHAVIOR
- */
-export {};

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

@@ -1,27 +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-VISITORS-BEHAVIOR - Behavior tests for visitors in require-story-visitors.ts
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-VISITORS-BEHAVIOR
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const require_story_visitors_1 = require("../../src/rules/helpers/require-story-visitors");
-const makeVisitors = () => {
-    const fakeContext = { getFilename: () => "file.ts" };
-    const fakeSource = { getText: () => "" };
-    const options = { shouldProcessNode: () => true };
-    return (0, require_story_visitors_1.buildVisitors)(fakeContext, fakeSource, options);
-};
-describe("Require Story Visitors - behavior (Story 003.0)", () => {
-    test("build visitors returns handlers for FunctionDeclaration and ArrowFunctionExpression", () => {
-        const visitors = makeVisitors();
-        expect(typeof visitors.FunctionDeclaration).toBe("function");
-        expect(typeof visitors.ArrowFunctionExpression).toBe("function");
-    });
-    test("FunctionDeclaration handler uses context.getFilename and doesn't throw when node lacks id", () => {
-        const visitors = makeVisitors();
-        const handler = visitors.FunctionDeclaration;
-        expect(() => handler({})).not.toThrow();
-    });
-});

package/lib/tests/rules/require-test-traceability.test.d.ts

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

package/lib/tests/rules/require-test-traceability.test.js

@@ -1,95 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable traceability/valid-annotation-format */
-/**
- * Tests for:
- * - docs/stories/020.0-DEV-TEST-ANNOTATION-VALIDATION.story.md
- * - docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md
- * @supports docs/stories/020.0-DEV-TEST-ANNOTATION-VALIDATION.story.md REQ-TEST-FILE-SUPPORTS REQ-TEST-DESCRIBE-STORY REQ-TEST-IT-REQ-PREFIX REQ-TEST-FRAMEWORK-COMPAT REQ-TEST-PATTERN-DETECT
- * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-TEMPLATE REQ-TEST-FIX-PREFIX-FORMAT REQ-TEST-FIX-SAFE REQ-TEST-FIX-PRESERVE REQ-TEST-FIX-PLACEHOLDER REQ-TEST-FIX-NO-INFERENCE
- */
-const eslint_1 = require("eslint");
-const require_test_traceability_1 = __importDefault(require("../../src/rules/require-test-traceability"));
-const ruleTester = new eslint_1.RuleTester({
-    languageOptions: {
-        parserOptions: { ecmaVersion: 2020, sourceType: "module" },
-    },
-});
-describe("require-test-traceability rule (Stories 020.0 and 021.0)", () => {
-    ruleTester.run("require-test-traceability", require_test_traceability_1.default, {
-        valid: [
-            {
-                // [REQ-TEST-FILE-SUPPORTS] file-level @supports present and describe/test satisfied
-                code: `/**\n * @supports docs/stories/020.0-DEV-TEST-ANNOTATION-VALIDATION.story.md REQ-TEST-FILE-SUPPORTS\n */\ndescribe('Story 020.0-DEV-TEST-ANNOTATION-VALIDATION', () => { it('[REQ-EXAMPLE] does something', () => {}); });`,
-                filename: "tests/rules/require-test-traceability.test.ts",
-            },
-            {
-                // [REQ-TEST-FRAMEWORK-COMPAT] mocha style `context` is treated as a test call but only name checks apply
-                code: `/**\n * @supports docs/stories/020.0-DEV-TEST-ANNOTATION-VALIDATION.story.md REQ-TEST-FRAMEWORK-COMPAT\n */\ncontext('Story 020.0-DEV-TEST-ANNOTATION-VALIDATION', () => {});`,
-                filename: "tests/some/context.test.ts",
-            },
-            {
-                // Ensure non-test files are ignored (REQ-TEST-PATTERN-DETECT)
-                code: `/**\n * @supports docs/stories/020.0-DEV-TEST-ANNOTATION-VALIDATION.story.md REQ-TEST-PATTERN-DETECT\n */\ndescribe('Story 020.0-DEV-TEST-ANNOTATION-VALIDATION', () => {});`,
-                filename: "src/not-a-test-file.ts",
-            },
-            {
-                // [REQ-TEST-FIX-PREFIX-FORMAT] already-correct [REQ-XXX] prefix is left unchanged by auto-fix
-                code: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\ndescribe('Story 021.0-DEV-TEST-ANNOTATION-AUTO-FIX', () => { it('[REQ-TRACE-123] behaves correctly', () => {}); });`,
-                filename: "tests/rules/correct-prefix-autofix.test.ts",
-            },
-        ],
-        invalid: [
-            {
-                // [REQ-TEST-FIX-TEMPLATE] missing @supports in test file -> insert default placeholder template
-                code: `describe('Story 020.0-DEV-TEST-ANNOTATION-VALIDATION', () => { it('[REQ-ONE] works', () => {}); });`,
-                output: `/**\n * @supports docs/stories/XXX.X-STORY-NAME.story.md REQ-XXX-YYY REQ-XXX-ZZZ\n * TODO: Replace the placeholder story path and REQ-IDs with real values for this test file.\n */\ndescribe('Story 020.0-DEV-TEST-ANNOTATION-VALIDATION', () => { it('[REQ-ONE] works', () => {}); });`,
-                filename: "tests/rules/missing-supports.test.ts",
-                errors: [{ messageId: "missingFileSupports" }],
-            },
-            {
-                // [REQ-TEST-DESCRIBE-STORY] describe without story phrase still reported (no auto-fix)
-                code: `/**\n * @supports docs/stories/020.0-DEV-TEST-ANNOTATION-VALIDATION.story.md REQ-TEST-DESCRIBE-STORY\n */\ndescribe('no story reference here', () => {});`,
-                filename: "tests/rules/bad-describe.test.ts",
-                errors: [{ messageId: "missingDescribeStory" }],
-            },
-            {
-                // [REQ-TEST-IT-REQ-PREFIX][REQ-TEST-FIX-NO-INFERENCE] test name without any REQ prefix -> error but no auto-fix
-                code: `/**\n * @supports docs/stories/020.0-DEV-TEST-ANNOTATION-VALIDATION.story.md REQ-TEST-IT-REQ-PREFIX\n */\nit('missing prefix', () => {});`,
-                filename: "tests/rules/bad-test-name-no-prefix.test.ts",
-                errors: [{ messageId: "missingReqPrefix" }],
-            },
-            {
-                // [REQ-TEST-FIX-PREFIX-FORMAT] malformed prefix with extra spaces in brackets
-                code: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('[ REQ-TEST-FIX ] does something', () => {});`,
-                output: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('[REQ-TEST-FIX] does something', () => {});`,
-                filename: "tests/rules/malformed-prefix-spacing.test.ts",
-                errors: [{ messageId: "missingReqPrefix" }],
-            },
-            {
-                // [REQ-TEST-FIX-PREFIX-FORMAT] malformed prefix with underscore delimiter
-                code: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('[REQ_TEST_FIX] does something', () => {});`,
-                output: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('[REQ-TEST-FIX] does something', () => {});`,
-                filename: "tests/rules/malformed-prefix-underscore.test.ts",
-                errors: [{ messageId: "missingReqPrefix" }],
-            },
-            {
-                // [REQ-TEST-FIX-PREFIX-FORMAT] malformed prefix with lowercase req
-                code: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('[req-lowercase] bad casing', () => {});`,
-                output: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('[REQ-LOWERCASE] bad casing', () => {});`,
-                filename: "tests/rules/malformed-prefix-lowercase.test.ts",
-                errors: [{ messageId: "missingReqPrefix" }],
-            },
-            {
-                // [REQ-TEST-FIX-PREFIX-FORMAT] malformed prefix using parentheses
-                code: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('(REQ-PAREN) with parens', () => {});`,
-                output: `/**\n * @supports docs/stories/021.0-DEV-TEST-ANNOTATION-AUTO-FIX.story.md REQ-TEST-FIX-PREFIX-FORMAT\n */\nit('[REQ-PAREN] with parens', () => {});`,
-                filename: "tests/rules/malformed-prefix-parens.test.ts",
-                errors: [{ messageId: "missingReqPrefix" }],
-            },
-        ],
-    });
-});

package/lib/tests/rules/valid-annotation-format-internal.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * Tests for: docs/stories/024.0-DEV-IGNORE-INLINE-CODE-REFS.story.md
- * @story docs/stories/024.0-DEV-IGNORE-INLINE-CODE-REFS.story.md
- * @req REQ-IGNORE-INLINE-CODE - Strip backtick-wrapped content before annotation detection
- * @req REQ-PRESERVE-BOUNDARIES - Replace backtick-wrapped content with spaces to preserve word boundaries
- * @req REQ-CENTRALIZED-FILTER - Apply backtick filtering in normalizeCommentLine for all rules
- */
-export {};

package/lib/tests/rules/valid-annotation-format-internal.test.js

@@ -1,47 +0,0 @@
-"use strict";
-/**
- * Tests for: docs/stories/024.0-DEV-IGNORE-INLINE-CODE-REFS.story.md
- * @story docs/stories/024.0-DEV-IGNORE-INLINE-CODE-REFS.story.md
- * @req REQ-IGNORE-INLINE-CODE - Strip backtick-wrapped content before annotation detection
- * @req REQ-PRESERVE-BOUNDARIES - Replace backtick-wrapped content with spaces to preserve word boundaries
- * @req REQ-CENTRALIZED-FILTER - Apply backtick filtering in normalizeCommentLine for all rules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const globals_1 = require("@jest/globals");
-const valid_annotation_format_internal_1 = require("../../src/rules/helpers/valid-annotation-format-internal");
-(0, globals_1.describe)("normalizeCommentLine inline code filtering (Story 024.0-DEV-IGNORE-INLINE-CODE-REFS)", () => {
-    (0, globals_1.it)("[REQ-IGNORE-INLINE-CODE] ignores backtick-wrapped @story in line without real annotations", () => {
-        const raw = "This rule uses `@story` and other tags";
-        const normalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(raw);
-        (0, globals_1.expect)(normalized).toBe("This rule uses          and other tags");
-        (0, globals_1.expect)(normalized).not.toMatch(/@story|@req|@supports/);
-    });
-    (0, globals_1.it)("[REQ-IGNORE-INLINE-CODE] ignores backtick-wrapped @req in line without real annotations", () => {
-        const raw = "Legacy pattern `@req` should not be treated as annotation";
-        const normalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(raw);
-        (0, globals_1.expect)(normalized).toBe("Legacy pattern        should not be treated as annotation");
-        (0, globals_1.expect)(normalized).not.toMatch(/@story|@req|@supports/);
-    });
-    (0, globals_1.it)("[REQ-IGNORE-INLINE-CODE][REQ-PRESERVE-BOUNDARIES] preserves spacing when removing backtick segments", () => {
-        const raw = "`@story` + `@req` docs";
-        const normalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(raw);
-        (0, globals_1.expect)(normalized).toBe("         +        docs");
-        (0, globals_1.expect)(normalized).not.toMatch(/@story|@req|@supports/);
-    });
-    (0, globals_1.it)("[REQ-IGNORE-INLINE-CODE] still detects real @story annotation outside backticks", () => {
-        const raw = "using `@supports` and real @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md";
-        const normalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(raw);
-        (0, globals_1.expect)(normalized).toBe("@story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md");
-    });
-    (0, globals_1.it)("[REQ-IGNORE-INLINE-CODE][REQ-PRESERVE-BOUNDARIES] handles multiple backtick segments on one line", () => {
-        const raw = "first `@story` and second `@req` markers";
-        const normalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(raw);
-        (0, globals_1.expect)(normalized).toBe("first          and second        markers");
-        (0, globals_1.expect)(normalized).not.toMatch(/@story|@req|@supports/);
-    });
-    (0, globals_1.it)("[REQ-IGNORE-INLINE-CODE] leaves lines without backticks unchanged apart from existing normalization", () => {
-        const raw = " * @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md";
-        const normalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(raw);
-        (0, globals_1.expect)(normalized).toBe("@story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md");
-    });
-});

package/lib/tests/rules/valid-annotation-format.test.d.ts

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