eslint-plugin-traceability 1.23.0 → 1.23.1

package/lib/tests/integration/cli-integration.test.js

@@ -1,96 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Tests for CLI integration of the traceability plugin.
- * Validates that the plugin registers correctly and enforces
- * traceability-related rules when invoked via the ESLint CLI.
- *
- * @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-PLUGIN-STRUCTURE
- * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
- */
-/**
- * Tests for CLI integration functionality
- * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
- * @req REQ-PLUGIN-STRUCTURE - Validate plugin registers via CLI
- */
-const child_process_1 = require("child_process");
-const path_1 = __importDefault(require("path"));
-describe("CLI Integration (Story 001.0-DEV-PLUGIN-SETUP)", () => {
-    const eslintPkgDir = path_1.default.dirname(require.resolve("eslint/package.json"));
-    const eslintCliPath = path_1.default.join(eslintPkgDir, "bin", "eslint.js");
-    const configPath = path_1.default.resolve(__dirname, "../../eslint.config.js");
-    const tests = [
-        {
-            name: "reports error when @story annotation is missing",
-            code: "function foo() {}",
-            rule: "traceability/require-story-annotation:error",
-            expectedStatus: 1,
-        },
-        {
-            name: "does not report error when @story annotation is present",
-            code: `/**
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED
- */
-function foo() {}`,
-            rule: "traceability/require-story-annotation:error",
-            expectedStatus: 0,
-        },
-        {
-            name: "reports error when @req annotation is missing",
-            code: "function bar() {}",
-            rule: "traceability/require-req-annotation:error",
-            expectedStatus: 1,
-        },
-        {
-            name: "reports error when @story annotation uses path traversal and @req annotation uses path traversal",
-            code: `/**
- * @story ../docs/stories/invalid.story.md
- * @req ../docs/requirements/REQ-INVALID.md
- */
-function bar() {}`,
-            rule: "traceability/valid-req-reference:error",
-            expectedStatus: 1,
-        },
-        {
-            name: "reports error when @story annotation uses absolute path and @req annotation uses absolute path",
-            code: `/**
- * @story /absolute/path/to/story.story.md
- * @req /etc/passwd
- */
-function baz() {}`,
-            rule: "traceability/valid-req-reference:error",
-            expectedStatus: 1,
-        },
-    ];
-    /**
-     * Helper to run ESLint CLI with a single rule for integration tests
-     * @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-PLUGIN-STRUCTURE
-     */
-    function runEslint(code, rule) {
-        const args = [
-            "--no-config-lookup",
-            "--config",
-            configPath,
-            "--stdin",
-            "--stdin-filename",
-            "foo.js",
-            "--rule",
-            "no-unused-vars:off",
-            "--rule",
-            rule,
-        ];
-        const result = (0, child_process_1.spawnSync)(process.execPath, [eslintCliPath, ...args], {
-            encoding: "utf-8",
-            input: code,
-        });
-        return result;
-    }
-    it.each(tests)("[REQ-PLUGIN-STRUCTURE] $name", ({ code, rule, expectedStatus }) => {
-        const result = runEslint(code, rule);
-        expect(result.status).toBe(expectedStatus);
-    });
-});

package/lib/tests/integration/else-if-annotation-prettier.integration.test.d.ts

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

package/lib/tests/integration/else-if-annotation-prettier.integration.test.js

@@ -1,100 +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 */
-/**
- * Prettier integration tests for else-if annotation positions.
- * @story docs/stories/026.0-DEV-ELSE-IF-ANNOTATION-POSITION.story.md
- * @supports docs/stories/026.0-DEV-ELSE-IF-ANNOTATION-POSITION.story.md REQ-PRETTIER-AUTOFIX-ELSE-IF
- */
-const path_1 = __importDefault(require("path"));
-const child_process_1 = require("child_process");
-const prettier_test_helpers_1 = require("./prettier-test-helpers");
-describe("Else-if annotations with Prettier (Story 026.0-DEV-ELSE-IF-ANNOTATION-POSITION)", () => {
-    const eslintPkgDir = path_1.default.dirname(require.resolve("eslint/package.json"));
-    const eslintCliPath = path_1.default.join(eslintPkgDir, "bin", "eslint.js");
-    const configPath = path_1.default.resolve(__dirname, "../../eslint.config.js");
-    function runEslintWithRequireBranchAnnotation(code) {
-        const args = [
-            "--no-config-lookup",
-            "--config",
-            configPath,
-            "--stdin",
-            "--stdin-filename",
-            "else-if.js",
-            "--rule",
-            "no-unused-vars:off",
-            "--rule",
-            "no-magic-numbers:off",
-            "--rule",
-            "no-undef:off",
-            "--rule",
-            "no-console:off",
-            "--rule",
-            "traceability/require-branch-annotation:error",
-        ];
-        return (0, child_process_1.spawnSync)(process.execPath, [eslintCliPath, ...args], {
-            encoding: "utf-8",
-            input: code,
-        });
-    }
-    it("[REQ-PRETTIER-COMPATIBILITY-ELSE-IF-BEFORE] accepts code where annotations start before else-if but are moved between condition and body by Prettier", () => {
-        const original = `
-function doA() {
-  return 1;
-}
-
-function doB() {
-  return 2;
-}
-
-// @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-// @req REQ-BRANCH-DETECTION
-if (aVeryLongConditionThatForcesPrettierToWrapTheElseIfBranch && anotherCondition) {
-  doA();
-}
-// @story docs/stories/026.0-DEV-ELSE-IF-ANNOTATION-POSITION.story.md
-// @req REQ-DUAL-POSITION-DETECTION-ELSE-IF
-else if (anotherVeryLongConditionThatForcesWrapping && someOtherCondition) {
-  doB();
-}
-`;
-        const formatted = (0, prettier_test_helpers_1.formatWithPrettier)(original);
-        // Sanity checks: Prettier should keep both the else-if branch and the associated story annotation,
-        // but the exact layout and comment movement may vary between versions.
-        expect(formatted).toContain("else if");
-        expect(formatted).toContain("@story docs/stories/026.0-DEV-ELSE-IF-ANNOTATION-POSITION.story.md");
-        const result = runEslintWithRequireBranchAnnotation(formatted);
-        expect(result.status).toBe(0);
-    });
-    it("[REQ-PRETTIER-COMPATIBILITY-ELSE-IF-INSIDE] accepts code where annotations start between condition and body and are preserved by Prettier", () => {
-        const original = `
-function doA() {
-  return 1;
-}
-
-function doB() {
-  return 2;
-}
-
-// @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-// @req REQ-BRANCH-DETECTION
-if (aVeryLongConditionThatForcesPrettierToWrapTheElseIfBranch && anotherCondition) {
-  doA();
-} else if (
-  anotherVeryLongConditionThatForcesWrapping && someOtherCondition
-) {
-  // @story docs/stories/026.0-DEV-ELSE-IF-ANNOTATION-POSITION.story.md
-  // @req REQ-DUAL-POSITION-DETECTION-ELSE-IF
-  doB();
-}
-`;
-        const formatted = (0, prettier_test_helpers_1.formatWithPrettier)(original);
-        // Note: Prettier's exact layout of the else-if and its comments may differ between versions;
-        // the rule should accept any of the supported annotation positions regardless of formatting.
-        const result = runEslintWithRequireBranchAnnotation(formatted);
-        expect(result.status).toBe(0);
-    });
-});

package/lib/tests/integration/no-redundant-annotation.integration.test.d.ts

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

package/lib/tests/integration/no-redundant-annotation.integration.test.js

@@ -1,129 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Integration tests for no-redundant-annotation rule across multiple files
- * @supports docs/stories/027.0-DEV-REDUNDANT-ANNOTATION-DETECTION.story.md REQ-REDUNDANCY-PATTERNS REQ-SAFE-REMOVAL REQ-SCOPE-INHERITANCE
- */
-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,
-        },
-        rules: {},
-    };
-    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("no-redundant-annotation integration (Story 027.0-DEV-REDUNDANT-ANNOTATION-DETECTION)", () => {
-    it("[REQ-REDUNDANCY-PATTERNS] cleans up redundant annotations in multiple files while preserving required ones", async () => {
-        const codeA = `// @story docs/stories/003.0-EXAMPLE.story.md
-// @req REQ-INIT
-function init() {
-  // @story docs/stories/003.0-EXAMPLE.story.md
-  // @req REQ-INIT
-  const config = loadConfig();
-  const validator = new Validator(config);
-}`;
-        const codeB = `/**
- * @story docs/stories/004.0-EXAMPLE.story.md
- * @req REQ-PROCESS
- */
-function process(value) {
-  if (value) {
-    /* @story docs/stories/004.0-EXAMPLE.story.md
-     * @req REQ-PROCESS
-     */
-    return handle(value);
-  }
-}`;
-        const config = {
-            rules: {
-                "traceability/no-redundant-annotation": ["warn"],
-            },
-        };
-        const [resultA, resultB] = await Promise.all([
-            lintTextWithConfig(codeA, "file-a.js", config),
-            lintTextWithConfig(codeB, "file-b.js", config),
-        ]);
-        expect(resultA.messages.map((m) => m.ruleId)).toContain("traceability/no-redundant-annotation");
-        expect(resultB.messages.map((m) => m.ruleId)).toContain("traceability/no-redundant-annotation");
-        const fixerConfig = {
-            rules: {
-                "traceability/no-redundant-annotation": ["warn"],
-            },
-            fix: true,
-        };
-        const eslintFix = new use_at_your_own_risk_1.FlatESLint({
-            overrideConfig: [
-                {
-                    plugins: { traceability: index_1.default },
-                    rules: fixerConfig.rules,
-                },
-            ],
-            overrideConfigFile: true,
-            ignore: false,
-            fix: true,
-        });
-        const [fixedA, fixedB] = await Promise.all([
-            (async () => {
-                const [result] = await eslintFix.lintText(codeA, {
-                    filePath: "file-a.js",
-                });
-                return result;
-            })(),
-            (async () => {
-                const [result] = await eslintFix.lintText(codeB, {
-                    filePath: "file-b.js",
-                });
-                return result;
-            })(),
-        ]);
-        expect(fixedA.output).toContain("// @story docs/stories/003.0-EXAMPLE.story.md");
-        expect(fixedA.output).toContain("// @req REQ-INIT");
-        expect(fixedA.output).not.toContain("// @req REQ-INIT\n  const config");
-        expect(fixedB.output).toContain("@story docs/stories/004.0-EXAMPLE.story.md");
-        expect(fixedB.output).toContain("@req REQ-PROCESS");
-        expect(fixedB.output).not.toContain("@req REQ-PROCESS\n     */\n    return");
-    });
-    it("[REQ-CATCH-BLOCK-HANDLING] does not report redundant annotations for try/if/else-if/catch pattern from story 027.0 (regression from issue #6)", async () => {
-        const code = `// @supports prompts/004.0-DEV-FILTER-VULNERABLE-VERSIONS.md
-// @req REQ-SAFE-ONLY
-async function filterVulnerableVersions(versionInfo, safeVersions) {
-  try {
-    // @supports prompts/004.0-DEV-FILTER-VULNERABLE-VERSIONS.md
-    // @req REQ-SAFE-ONLY
-    if (!versionInfo) {
-      return [];
-    } else if (!safeVersions || safeVersions.length === 0) {
-      return versionInfo;
-    }
-
-    // @supports prompts/004.0-DEV-FILTER-VULNERABLE-VERSIONS.md
-    // @req REQ-SAFE-ONLY
-    return versionInfo.filter(v => safeVersions.includes(v));
-  } catch (error) {
-    // @supports prompts/004.0-DEV-FILTER-VULNERABLE-VERSIONS.md
-    // @req REQ-SAFE-ONLY
-    return [];
-  }
-}
-`;
-        const config = {
-            rules: {
-                "traceability/no-redundant-annotation": ["warn"],
-            },
-        };
-        const result = await lintTextWithConfig(code, "filter-vulnerable-versions.js", config);
-        expect(result.messages.filter((m) => m.ruleId === "traceability/no-redundant-annotation").length).toBe(0);
-    });
-});

package/lib/tests/integration/prettier-test-helpers.d.ts

@@ -1,9 +0,0 @@
-interface FormatOptions {
-    parser?: "babel" | "typescript" | "babel-ts" | "espree" | string;
-}
-/**
- * Format arbitrary source with Prettier using the installed CLI binary.
- * Defaults to the TypeScript parser when none is provided.
- */
-export declare function formatWithPrettier(source: string, options?: FormatOptions): string;
-export {};

package/lib/tests/integration/prettier-test-helpers.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatWithPrettier = formatWithPrettier;
-/* eslint-disable traceability/valid-annotation-format */
-/**
- * Shared helpers for Prettier-based integration tests.
- * @story docs/stories/025.0-DEV-CATCH-ANNOTATION-POSITION.story.md
- * @story docs/stories/026.0-DEV-ELSE-IF-ANNOTATION-POSITION.story.md
- * @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
- * @supports docs/stories/025.0-DEV-CATCH-ANNOTATION-POSITION.story.md REQ-PRETTIER-COMPATIBILITY
- * @supports docs/stories/026.0-DEV-ELSE-IF-ANNOTATION-POSITION.story.md REQ-PRETTIER-AUTOFIX-ELSE-IF
- * @supports docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md REQ-PRETTIER-STABLE
- */
-const path_1 = __importDefault(require("path"));
-const child_process_1 = require("child_process");
-/**
- * Format arbitrary source with Prettier using the installed CLI binary.
- * Defaults to the TypeScript parser when none is provided.
- */
-function formatWithPrettier(source, options = {}) {
-    const prettierPackageJson = require.resolve("prettier/package.json");
-    const prettierCliPath = path_1.default.join(path_1.default.dirname(prettierPackageJson), "bin", "prettier.cjs");
-    const parser = options.parser || "typescript";
-    const result = (0, child_process_1.spawnSync)(process.execPath, [prettierCliPath, "--parser", parser], {
-        encoding: "utf-8",
-        input: source,
-    });
-    if (result.status !== 0) {
-        throw new Error(`Prettier formatting failed: ${result.stderr || result.stdout}`);
-    }
-    return result.stdout;
-}

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

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

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 {};