eslint-plugin-traceability 1.22.0 → 1.23.1

package/lib/tests/integration/require-traceability-aliases.integration.test.js

@@ -1,152 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Integration tests for unified require-traceability rule and its legacy aliases.
- *
- * @supports docs/stories/010.4-DEV-UNIFIED-FUNCTION-RULE-AND-ALIASES.story.md REQ-UNIFIED-ALIAS-ENGINE REQ-SUPPORTS-FIRST-MODEL REQ-PRESETS-CANONICAL-RULE
- */
-const use_at_your_own_risk_1 = require("eslint/use-at-your-own-risk");
-const index_1 = __importStar(require("../../src/index"));
-async function lintTextWithConfig(text, filename, extraConfig) {
-    const baseConfig = {
-        plugins: {
-            traceability: index_1.default,
-        },
-    };
-    const eslint = new use_at_your_own_risk_1.FlatESLint({
-        overrideConfig: [baseConfig, ...extraConfig],
-        overrideConfigFile: true,
-        ignore: false,
-    });
-    const [result] = await eslint.lintText(text, { filePath: filename });
-    return result;
-}
-describe("Unified require-traceability and aliases integration (Story 010.4-DEV-UNIFIED-FUNCTION-RULE-AND-ALIASES)", () => {
-    const codeMissingAll = "function foo() {}";
-    const codeWithSupportsOnly = `/**\n * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ANNOTATION-REQUIRED\n */\nfunction foo() {}`;
-    const codeWithStoryAndReq = `/**\n * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md\n * @req REQ-ANNOTATION-REQUIRED\n */\nfunction foo() {}`;
-    async function getDiagnosticsForRule(ruleKey, code) {
-        const config = [
-            {
-                rules: {
-                    [ruleKey]: "error",
-                },
-            },
-        ];
-        const result = await lintTextWithConfig(code, "example.js", config);
-        return result.messages.map((m) => ({
-            ruleId: m.ruleId,
-            messageId: m.messageId,
-        }));
-    }
-    it("[REQ-UNIFIED-ALIAS-ENGINE] canonical and alias keys all report missing traceability on unannotated function", async () => {
-        const ruleKeys = [
-            "traceability/require-traceability",
-            "traceability/require-story-annotation",
-            "traceability/require-req-annotation",
-        ];
-        const results = await Promise.all(ruleKeys.map((ruleKey) => getDiagnosticsForRule(ruleKey, codeMissingAll)));
-        results.forEach((messages, index) => {
-            const ruleKey = ruleKeys[index];
-            expect(messages.length).toBeGreaterThan(0);
-            messages.forEach((msg) => {
-                expect(msg.ruleId).toBe(ruleKey);
-            });
-        });
-    });
-    it("[REQ-SUPPORTS-FIRST-MODEL] @supports-only annotation satisfies all three rule keys", async () => {
-        const ruleKeys = [
-            "traceability/require-traceability",
-            "traceability/require-story-annotation",
-            "traceability/require-req-annotation",
-        ];
-        const results = await Promise.all(ruleKeys.map((ruleKey) => getDiagnosticsForRule(ruleKey, codeWithSupportsOnly)));
-        results.forEach((messages) => {
-            expect(messages).toHaveLength(0);
-        });
-    });
-    it("[REQ-SUPPORTS-FIRST-MODEL] @story + @req annotation satisfies all three rule keys", async () => {
-        const ruleKeys = [
-            "traceability/require-traceability",
-            "traceability/require-story-annotation",
-            "traceability/require-req-annotation",
-        ];
-        const results = await Promise.all(ruleKeys.map((ruleKey) => getDiagnosticsForRule(ruleKey, codeWithStoryAndReq)));
-        results.forEach((messages) => {
-            expect(messages).toHaveLength(0);
-        });
-    });
-    it("[REQ-INSIDE-BRACE-PLACEMENT][REQ-ALL-BLOCK-TYPES] unified rule and aliases accept inside-brace annotations when annotationPlacement is 'inside'", async () => {
-        const codeWithInsideAnnotations = `function foo() {\n  // @supports docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md REQ-FN-INSIDE\n  return 1;\n}`;
-        const config = [
-            {
-                rules: {
-                    "traceability/require-traceability": "error",
-                    "traceability/require-story-annotation": [
-                        "error",
-                        {
-                            annotationPlacement: "inside",
-                        },
-                    ],
-                    "traceability/require-req-annotation": [
-                        "error",
-                        {
-                            annotationPlacement: "inside",
-                        },
-                    ],
-                },
-            },
-        ];
-        const result = await lintTextWithConfig(codeWithInsideAnnotations, "example.js", config);
-        const ruleIds = result.messages.map((m) => m.ruleId);
-        expect(ruleIds).not.toContain("traceability/require-story-annotation");
-        expect(ruleIds).not.toContain("traceability/require-req-annotation");
-    });
-    it("[REQ-PRESETS-CANONICAL-RULE] recommended preset surfaces unified and legacy diagnostics together for missing annotations", async () => {
-        const result = await lintTextWithConfig(codeMissingAll, "example.js", index_1.configs.recommended);
-        const ruleIds = result.messages.map((m) => m.ruleId).sort();
-        expect(ruleIds).toContain("traceability/require-traceability");
-        expect(ruleIds).toContain("traceability/require-story-annotation");
-        expect(ruleIds).toContain("traceability/require-req-annotation");
-    });
-    it("[REQ-PRESETS-CANONICAL-RULE] strict preset surfaces unified and legacy diagnostics together for missing annotations", async () => {
-        const result = await lintTextWithConfig(codeMissingAll, "example.js", index_1.configs.strict);
-        const ruleIds = result.messages.map((m) => m.ruleId).sort();
-        expect(ruleIds).toContain("traceability/require-traceability");
-        expect(ruleIds).toContain("traceability/require-story-annotation");
-        expect(ruleIds).toContain("traceability/require-req-annotation");
-    });
-});

package/lib/tests/integration/require-traceability-test-callbacks.integration.test.d.ts

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

package/lib/tests/integration/require-traceability-test-callbacks.integration.test.js

@@ -1,149 +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 */
-/**
- * Integration tests for require-traceability with configurable test callback exclusion.
- *
- * @supports docs/stories/010.4-DEV-UNIFIED-FUNCTION-RULE-AND-ALIASES.story.md REQ-UNIFIED-ALIAS-ENGINE
- * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ANNOTATION-REQUIRED REQ-FUNCTION-DETECTION
- * @supports docs/stories/013-exclude-test-framework-callbacks.proposed.md REQ-TEST-CALLBACK-EXCLUSION
- */
-const use_at_your_own_risk_1 = require("eslint/use-at-your-own-risk");
-const index_1 = __importDefault(require("../../src/index"));
-async function lintTextWithConfig(text, filename, extraConfig) {
-    const baseConfig = {
-        plugins: {
-            traceability: index_1.default,
-        },
-    };
-    const eslint = new use_at_your_own_risk_1.FlatESLint({
-        overrideConfig: [baseConfig, ...extraConfig],
-        overrideConfigFile: true,
-        ignore: false,
-    });
-    const [result] = await eslint.lintText(text, { filePath: filename });
-    return result;
-}
-describe("Unified require-traceability with configurable test callback exclusion (Story 013-exclude-test-framework-callbacks)", () => {
-    const baseHeader = `/**\n * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ANNOTATION-REQUIRED\n */`;
-    const jsTestCallback = `${baseHeader}\n
-describe('suite', () => {\n  it('does something', () => {\n    const value = 1;\n  });\n});`;
-    const tsTestCallback = `${baseHeader}\n
-import { describe, it } from 'vitest';
-
-describe('suite', () => {\n  it('does something', () => {\n    const value = 1;\n  });\n});`;
-    const jsBenchCallback = `${baseHeader}\n
-import { bench } from 'vitest';
-
-bench('bench case', () => {\n  function helper() {}\n  helper();\n});`;
-    const jsCustomHelperCallback = `${baseHeader}\n
-function helperWrapper(fn) {\n  return fn;\n}
-
-helperWrapper(() => {\n  function helper() {}\n  helper();\n});`;
-    async function getRuleMessages(code, filename, extraConfig) {
-        const result = await lintTextWithConfig(code, filename, extraConfig);
-        return result.messages.filter((m) => m.ruleId === "traceability/require-traceability" ||
-            m.ruleId === "traceability/require-story-annotation");
-    }
-    it("[REQ-TEST-CALLBACK-EXCLUSION] excludes callbacks under known test helpers when configured", async () => {
-        const config = [
-            {
-                rules: {
-                    "traceability/require-traceability": ["error"],
-                    "traceability/require-story-annotation": [
-                        "error",
-                        {
-                            excludeTestCallbacks: true,
-                        },
-                    ],
-                },
-            },
-        ];
-        const messagesJs = await getRuleMessages(jsTestCallback, "example.test.js", config);
-        const messagesTs = await getRuleMessages(tsTestCallback, "example.test.ts", config);
-        expect(messagesJs).toHaveLength(0);
-        expect(messagesTs).toHaveLength(0);
-    });
-    it("[REQ-TEST-CALLBACK-EXCLUSION] never excludes Vitest bench callbacks via test-callback exclusion, even when exclusion is enabled", async () => {
-        const baseConfig = [
-            {
-                rules: {
-                    "traceability/require-traceability": ["error"],
-                    "traceability/require-story-annotation": [
-                        "error",
-                        {
-                            excludeTestCallbacks: true,
-                        },
-                    ],
-                },
-            },
-        ];
-        const withBenchAsHelperConfig = [
-            {
-                rules: {
-                    "traceability/require-traceability": ["error"],
-                    "traceability/require-story-annotation": [
-                        "error",
-                        {
-                            excludeTestCallbacks: true,
-                            additionalTestHelperNames: ["bench"],
-                        },
-                    ],
-                },
-            },
-        ];
-        const baseResult = await lintTextWithConfig(jsBenchCallback, "bench.test.ts", baseConfig);
-        const withBenchHelperResult = await lintTextWithConfig(jsBenchCallback, "bench.test.ts", withBenchAsHelperConfig);
-        const baseMessages = baseResult.messages.filter((m) => m.ruleId === "traceability/require-traceability" ||
-            m.ruleId === "traceability/require-story-annotation");
-        const withBenchHelperMessages = withBenchHelperResult.messages.filter((m) => m.ruleId === "traceability/require-traceability" ||
-            m.ruleId === "traceability/require-story-annotation");
-        expect(withBenchHelperMessages.length).toBeGreaterThanOrEqual(baseMessages.length);
-    });
-    it("[REQ-TEST-CALLBACK-EXCLUSION] respects additionalTestHelperNames for custom helpers but not for bench callbacks", async () => {
-        const baseConfig = [
-            {
-                rules: {
-                    "traceability/require-traceability": ["error"],
-                    "traceability/require-story-annotation": [
-                        "error",
-                        {
-                            excludeTestCallbacks: true,
-                        },
-                    ],
-                },
-            },
-        ];
-        const withAdditionalHelpersConfig = [
-            {
-                rules: {
-                    "traceability/require-traceability": ["error"],
-                    "traceability/require-story-annotation": [
-                        "error",
-                        {
-                            excludeTestCallbacks: true,
-                            additionalTestHelperNames: ["helperWrapper", "bench"],
-                        },
-                    ],
-                },
-            },
-        ];
-        const wrapperBaseResult = await lintTextWithConfig(jsCustomHelperCallback, "helper-wrapper.test.ts", baseConfig);
-        const wrapperWithHelpersResult = await lintTextWithConfig(jsCustomHelperCallback, "helper-wrapper.test.ts", withAdditionalHelpersConfig);
-        const benchBaseResult = await lintTextWithConfig(jsBenchCallback, "bench.test.ts", baseConfig);
-        const benchWithHelpersResult = await lintTextWithConfig(jsBenchCallback, "bench.test.ts", withAdditionalHelpersConfig);
-        const wrapperBaseMessages = wrapperBaseResult.messages.filter((m) => m.ruleId === "traceability/require-traceability" ||
-            m.ruleId === "traceability/require-story-annotation");
-        const wrapperWithHelpersMessages = wrapperWithHelpersResult.messages.filter((m) => m.ruleId === "traceability/require-traceability" ||
-            m.ruleId === "traceability/require-story-annotation");
-        const benchBaseMessages = benchBaseResult.messages.filter((m) => m.ruleId === "traceability/require-traceability" ||
-            m.ruleId === "traceability/require-story-annotation");
-        const benchWithHelpersMessages = benchWithHelpersResult.messages.filter((m) => m.ruleId === "traceability/require-traceability" ||
-            m.ruleId === "traceability/require-story-annotation");
-        expect(wrapperWithHelpersMessages.length).toBeLessThanOrEqual(wrapperBaseMessages.length);
-        expect(benchWithHelpersMessages.length).toBeGreaterThanOrEqual(benchBaseMessages.length);
-    });
-});

package/lib/tests/maintenance/batch.test.d.ts

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

package/lib/tests/maintenance/batch.test.js

@@ -1,80 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Tests for: docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
- * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
- * @req REQ-MAINT-BATCH - Perform batch updates
- * @req REQ-MAINT-VERIFY - Verify annotation references
- * @supports docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md REQ-MAINT-BATCH REQ-MAINT-VERIFY
- */
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const temp_dir_helpers_1 = require("../utils/temp-dir-helpers");
-const batch_1 = require("../../src/maintenance/batch");
-describe("batchUpdateAnnotations (Story 009.0-DEV-MAINTENANCE-TOOLS)", () => {
-    let temp;
-    beforeAll(() => {
-        temp = (0, temp_dir_helpers_1.createTempDir)("batch-test-");
-    });
-    afterAll(() => {
-        temp.cleanup();
-    });
-    it("[REQ-MAINT-BATCH] should return 0 when no mappings applied", () => {
-        const count = (0, batch_1.batchUpdateAnnotations)(temp.dir, []);
-        expect(count).toBe(0);
-    });
-});
-describe("verifyAnnotations (Story 009.0-DEV-MAINTENANCE-TOOLS)", () => {
-    let temp;
-    beforeAll(() => {
-        temp = (0, temp_dir_helpers_1.createTempDir)("verify-test-");
-        const tsContent = `
-/**
- * Tests for: my-story.story.md
- * @story my-story.story.md
- */
-`;
-        fs.writeFileSync(path.join(temp.dir, "test.ts"), tsContent);
-        fs.writeFileSync(path.join(temp.dir, "my-story.story.md"), "# Dummy Story");
-    });
-    afterAll(() => {
-        temp.cleanup();
-    });
-    it("[REQ-MAINT-VERIFY] should return true when annotations are valid", () => {
-        const valid = (0, batch_1.verifyAnnotations)(temp.dir);
-        expect(valid).toBe(true);
-    });
-});

package/lib/tests/maintenance/cli.test.d.ts

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