eslint-plugin-traceability 1.23.0 → 1.24.0

package/CHANGELOG.md

@@ -1,9 +1,9 @@
-# [1.23.0](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.22.0...v1.23.0) (2026-01-10)
+# [1.24.0](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.23.1...v1.24.0) (2026-01-10)
 
 
 ### Features
 
-* **rules:** add ArrowFunctionExpression support to require-req-annotation ([92d2e60](https://github.com/voder-ai/eslint-plugin-traceability/commit/92d2e60686c661faa58c41fd533e7d9e6acbae18))
+* add auto-fix support to require-traceability rule ([ee35349](https://github.com/voder-ai/eslint-plugin-traceability/commit/ee353492bfbebbc18dba7ae8e4d32b8ec386bdf1))
 
 # Changelog
 

package/lib/{src/rules → rules}/require-traceability.js

@@ -39,7 +39,7 @@ const rule = {
             recommended: "error",
         },
         hasSuggestions: true,
-        fixable: undefined,
+        fixable: "code",
         messages: {
             // Unified messageId for potential future direct use by this rule.
             missingTraceability: "Function '{{name}}' must declare both story and requirement traceability annotations.",
@@ -48,11 +48,56 @@ const rule = {
             ...(storyRule.meta?.messages ?? {}),
             ...(reqRule.meta?.messages ?? {}),
         },
-        schema: [],
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    scope: {
+                        type: "array",
+                        items: {
+                            type: "string",
+                        },
+                    },
+                    exportPriority: {
+                        type: "string",
+                        enum: ["all", "exported", "non-exported"],
+                    },
+                    annotationTemplate: {
+                        type: "string",
+                    },
+                    methodAnnotationTemplate: {
+                        type: "string",
+                    },
+                    autoFix: {
+                        type: "boolean",
+                        description: "When false, disables automatic fix behavior while retaining diagnostics. When true (default), the rule inserts placeholder annotations in --fix mode.",
+                    },
+                    excludeTestCallbacks: {
+                        type: "boolean",
+                    },
+                    annotationPlacement: {
+                        type: "string",
+                        enum: ["before", "inside"],
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
     },
     create(context) {
-        const storyListeners = storyRule.create(context) || {};
-        const reqListeners = reqRule.create(context) || {};
+        // Create a modified context that passes through options to composed rules
+        // We need to preserve all context methods while modifying the options array
+        const options = context.options[0] || {};
+        const modifiedContext = Object.create(context, {
+            options: {
+                value: [options],
+                writable: false,
+                enumerable: true,
+                configurable: false,
+            },
+        });
+        const storyListeners = storyRule.create(modifiedContext) || {};
+        const reqListeners = reqRule.create(modifiedContext) || {};
         const mergedListener = {};
         const allEventNames = new Set([
             ...Object.keys(storyListeners),

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "description": "A customizable ESLint plugin that enforces traceability annotations in your code, ensuring each implementation is linked to its requirement or test case.",
-  "main": "lib/src/index.js",
-  "types": "lib/src/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
     "lib",
     "README.md",
@@ -16,11 +16,11 @@
     "doc": "docs"
   },
   "bin": {
-    "traceability-maint": "lib/src/maintenance/cli.js"
+    "traceability-maint": "lib/maintenance/cli.js"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "prepare": "husky",
+    "build": "tsc -p tsconfig.build.json",
+    "prepare": "node scripts/prepare.js",
     "type-check": "tsc --noEmit -p tsconfig.json",
     "check:traceability": "node scripts/traceability-check.js",
     "lint-plugin-check": "node scripts/lint-plugin-check.js",
@@ -31,7 +31,7 @@
     "test:unit": "jest --ci --bail --testPathPatterns='tests/(rules|maintenance|utils|unit)' --testPathIgnorePatterns='integration'",
     "test:integration": "jest --ci --bail --testPathPatterns='tests/integration'",
     "ci-verify": "npm run type-check && npm run lint && npm run format:check && npm run duplication && npm run check:traceability && npm test && npm run audit:ci && npm run safety:deps",
-    "ci-verify:full": "npm run check:traceability && npm run safety:deps && npm run audit:ci && npm run build && npm run type-check && npm run lint-plugin-check && npm run lint -- --max-warnings=0 && npm run duplication && npm run test -- --coverage && npm run format:check && npm audit --omit=dev --audit-level=high && npm run audit:dev-high && npm run check:ci-artifacts",
+    "ci-verify:full": "npm run check:traceability && npm run safety:deps && npm run audit:ci && npm run build && npm run smoke:runtime && npm run type-check && npm run lint-plugin-check && npm run lint -- --max-warnings=0 && npm run duplication && npm run test -- --coverage && npm run format:check && npm audit --omit=dev --audit-level=high && npm run audit:dev-high && npm run check:ci-artifacts",
     "ci-verify:fast": "npm run type-check && npm run check:traceability && npm run duplication && jest --ci --bail --passWithNoTests --testPathPatterns 'tests/(rules|maintenance)'",
     "format": "prettier --write .",
     "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
@@ -46,7 +46,7 @@
     "security:secrets": "secretlint \"**/*\"",
     "smoke-test": "./scripts/smoke-test.sh",
     "smoke:runtime": "./scripts/runtime-smoke.sh",
-    "run:cli": "node lib/src/maintenance/cli.js",
+    "run:cli": "node lib/maintenance/cli.js",
     "debug:cli": "node scripts/cli-debug.js",
     "debug:require-story": "node scripts/debug-require-story.js",
     "debug:repro": "node scripts/debug-repro.js",

package/user-docs/api-reference.md

@@ -32,6 +32,31 @@ All three rule keys can still be configured individually if you need fine-graine
 
 Description: Unified function-level traceability rule that composes the behavior of `traceability/require-story-annotation` and `traceability/require-req-annotation`. When enabled, it enforces that in‑scope functions and methods carry both a story reference (`@story` or an equivalent `@supports` tag) and at least one requirement reference (`@req` or, when configured, `@supports`). The recommended flat‑config presets in this plugin enable `traceability/require-traceability` by default alongside the legacy rule keys for backward compatibility, so that existing configurations referring to `traceability/require-story-annotation` or `traceability/require-req-annotation` continue to work without change.
 
+When run with `--fix`, the rule delegates auto-fix behavior to its composed rules, primarily adding placeholder `@story` annotations for missing story coverage via the underlying `require-story-annotation` implementation. The rule supports the same `autoFix` option as the legacy rules, allowing you to disable automatic fixes while retaining diagnostics. All options (including `annotationTemplate`, `methodAnnotationTemplate`, `autoFix`, `scope`, `exportPriority`, `excludeTestCallbacks`, and `annotationPlacement`) are passed through to the composed rules, ensuring consistent behavior across the unified and legacy rule keys.
+
+Options:
+
+- `scope` (string[], optional) – Controls which function-like node types are required to have traceability annotations. Passed through to composed rules. Default behavior matches require-story-annotation defaults.
+- `exportPriority` ("all" | "exported" | "non-exported", optional) – Controls whether the rule checks all functions, only exported ones, or only non-exported ones. Passed through to composed rules. Default: "all".
+- `annotationTemplate` (string, optional) – Overrides the default placeholder JSDoc used when inserting missing `@story` annotations. Passed through to require-story-annotation. When omitted or blank, the built-in template from Story 008.0 is used.
+- `methodAnnotationTemplate` (string, optional) – Overrides the default placeholder JSDoc used for class methods and TypeScript method signatures. Passed through to require-story-annotation.
+- `autoFix` (boolean, optional) – When set to `false`, disables all automatic fix behavior for this rule while retaining its suggestions and diagnostics. When omitted or `true`, the rule behaves as before, inserting placeholder annotations in `--fix` mode. This option is passed through to the composed rules.
+- `excludeTestCallbacks` (boolean, optional) – When `true` (default), excludes anonymous arrow functions that are direct callbacks to common test framework functions from annotation requirements. Passed through to composed rules.
+- `annotationPlacement` ("before" | "inside", optional) – Controls whether annotations are expected before functions (`"before"`, default) or as the first lines inside function bodies (`"inside"`). Passed through to composed rules.
+
+Default Severity: `error`
+Example:
+
+```javascript
+/**
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED
+ */
+function initAuth() {
+  // authentication logic
+}
+```
+
 ### traceability/require-story-annotation
 
 Description: **Legacy function-level key:** This rule key is retained for backward compatibility and conceptually composes the same checks as `traceability/require-traceability`. New configurations should normally enable `traceability/require-traceability` instead and rely on this key only when you need to tune it independently. Ensures every function declaration has a traceability annotation, preferring `@supports` for story coverage while still accepting legacy `@story` annotations referencing the related user story. When you adopt multi-story `@supports` annotations, this rule also accepts `@supports` as an alternative way to prove story coverage, so either `@story` or at least one `@supports` tag will satisfy the presence check. When run with `--fix`, the rule inserts a single-line placeholder JSDoc `@story` annotation above missing functions, methods, TypeScript declare functions, and interface method signatures using a built-in template aligned with Story 008.0. This template is now configurable on a per-rule basis, and the rule exposes an explicit auto-fix toggle so you can choose between diagnostic-only behavior and automatic placeholder insertion. The default template remains aligned with Story 008.0, but you can now customize it per rule configuration and optionally disable auto-fix entirely when you only want diagnostics without edits.

package/lib/tests/cli-error-handling.test.d.ts

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

package/lib/tests/cli-error-handling.test.js

@@ -1,54 +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 error handling when plugin loading fails
- * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
- * @req REQ-ERROR-HANDLING - Plugin CLI should exit with error on rule load failure
- * @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-ERROR-HANDLING
- */
-const child_process_1 = require("child_process");
-const path_1 = __importDefault(require("path"));
-const originalNodePath = process.env.NODE_PATH;
-describe("CLI Error Handling for Traceability Plugin (Story 001.0-DEV-PLUGIN-SETUP)", () => {
-    beforeAll(() => {
-        // Simulate missing plugin build by deleting lib directory (if exist)
-        // In tests, assume plugin built to lib/src/index.js; point plugin import to src/index.ts via env
-        process.env.NODE_PATH = path_1.default.resolve(__dirname, "../src");
-    });
-    afterAll(() => {
-        if (originalNodePath === undefined) {
-            delete process.env.NODE_PATH;
-        }
-        else {
-            process.env.NODE_PATH = originalNodePath;
-        }
-    });
-    it("[REQ-ERROR-HANDLING] should exit with error when rule module missing", () => {
-        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 code = `function foo() {}`;
-        const args = [
-            "--no-config-lookup",
-            "--config",
-            configPath,
-            "--stdin",
-            "--stdin-filename",
-            "foo.js",
-            "--rule",
-            "traceability/require-story-annotation:error",
-        ];
-        // Rename one of the rule files to simulate missing module
-        // However, modifying fs at CLI runtime isn't straightforward here; skip this test as implementation placeholder
-        const result = (0, child_process_1.spawnSync)(process.execPath, [eslintCliPath, ...args], {
-            encoding: "utf-8",
-            input: code,
-        });
-        // Expect non-zero exit and missing annotation message on stdout
-        expect(result.status).not.toBe(0);
-        expect(result.stdout).toContain("Function 'foo' must declare a traceability annotation. Prefer adding an @supports line that links this function to at least one story (for example, '@supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ANNOTATION-REQUIRED'), or, when you only need a single-story reference, add a legacy @story annotation that points to the implementing story file, such as docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md");
-    });
-});

package/lib/tests/config/eslint-config-validation.test.d.ts

@@ -1,9 +0,0 @@
-/**
- * Tests for ESLint config rule schemas.
- *
- * @supports docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- * @req REQ-RULE-OPTIONS
- * @req REQ-CONFIG-VALIDATION
- * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- */
-export {};

package/lib/tests/config/eslint-config-validation.test.js

@@ -1,101 +0,0 @@
-"use strict";
-/* eslint-disable traceability/valid-annotation-format */
-/**
- * Tests for ESLint config rule schemas.
- *
- * @supports docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- * @req REQ-RULE-OPTIONS
- * @req REQ-CONFIG-VALIDATION
- * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const valid_story_reference_1 = __importDefault(require("../../src/rules/valid-story-reference"));
-const use_at_your_own_risk_1 = require("eslint/use-at-your-own-risk");
-const index_1 = __importDefault(require("../../src/index"));
-/** @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md */
-describe("ESLint Configuration Setup (Story 002.0-DEV-ESLINT-CONFIG)", () => {
-    it("[REQ-RULE-OPTIONS] rule meta.schema defines expected properties", () => {
-        const schema = valid_story_reference_1.default.meta.schema[0];
-        expect(schema.properties).toHaveProperty("storyDirectories");
-        expect(schema.properties).toHaveProperty("allowAbsolutePaths");
-        expect(schema.properties).toHaveProperty("requireStoryExtension");
-    });
-    it("[REQ-CONFIG-VALIDATION] schema disallows unknown options", () => {
-        const schema = valid_story_reference_1.default.meta.schema[0];
-        expect(schema.additionalProperties).toBe(false);
-    });
-    it("[REQ-CONFIG-VALIDATION] ESLint throws on unknown rule option", async () => {
-        const eslint = new use_at_your_own_risk_1.FlatESLint({
-            overrideConfig: [
-                {
-                    plugins: {
-                        traceability: index_1.default,
-                    },
-                    rules: {
-                        "traceability/valid-story-reference": [
-                            "error",
-                            {
-                                storyDirectories: ["stories"],
-                                allowAbsolutePaths: false,
-                                requireStoryExtension: true,
-                                unknownOptionKey: true,
-                            },
-                        ],
-                    },
-                },
-            ],
-            overrideConfigFile: true,
-            ignore: false,
-        });
-        let caughtError;
-        try {
-            await eslint.lintText("const x = 1;");
-        }
-        catch (err) {
-            caughtError = err;
-        }
-        expect(caughtError).toBeInstanceOf(Error);
-        const message = String(caughtError.message || caughtError);
-        expect(message).toContain("traceability/valid-story-reference");
-        expect(message.toLowerCase()).toContain("additional");
-        expect(message.toLowerCase()).toContain("unexpected property");
-        expect(message).toContain("unknownOptionKey");
-    });
-    it("[REQ-CONFIG-VALIDATION] ESLint throws on invalid option type", async () => {
-        const eslint = new use_at_your_own_risk_1.FlatESLint({
-            overrideConfig: [
-                {
-                    plugins: {
-                        traceability: index_1.default,
-                    },
-                    rules: {
-                        "traceability/valid-story-reference": [
-                            "error",
-                            {
-                                // storyDirectories must be an array, not a string
-                                storyDirectories: "not-an-array",
-                            },
-                        ],
-                    },
-                },
-            ],
-            overrideConfigFile: true,
-            ignore: false,
-        });
-        let caughtError;
-        try {
-            await eslint.lintText("const y = 2;");
-        }
-        catch (err) {
-            caughtError = err;
-        }
-        expect(caughtError).toBeInstanceOf(Error);
-        const message = String(caughtError.message || caughtError);
-        expect(message).toContain("traceability/valid-story-reference");
-        expect(message).toContain("not-an-array");
-        expect(message.toLowerCase()).toContain("array");
-    });
-});

package/lib/tests/config/flat-config-presets-integration.test.d.ts

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

package/lib/tests/config/flat-config-presets-integration.test.js

@@ -1,76 +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 });
-/* eslint-disable traceability/valid-annotation-format */
-/**
- * Tests for: docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- * @supports docs/stories/002.0-DEV-ESLINT-CONFIG.story.md REQ-CONFIG-PRESETS REQ-FLAT-CONFIG REQ-PROJECT-INTEGRATION
- */
-const use_at_your_own_risk_1 = require("eslint/use-at-your-own-risk");
-const index_1 = __importStar(require("../../src/index"));
-const baseConfig = {
-    plugins: {
-        traceability: index_1.default,
-    },
-    rules: {},
-};
-async function lintTextWithConfig(text, config) {
-    const eslint = new use_at_your_own_risk_1.FlatESLint({
-        overrideConfig: config,
-        overrideConfigFile: true,
-        ignore: false,
-    });
-    const [result] = await eslint.lintText(text, { filePath: "example.js" });
-    return result;
-}
-describe("Flat config presets integration (Story 002.0-DEV-ESLINT-CONFIG)", () => {
-    it("[REQ-CONFIG-PRESETS] recommended preset enables traceability rules via documented usage", async () => {
-        const config = [baseConfig, ...index_1.configs.recommended];
-        const code = "function foo() {}";
-        const result = await lintTextWithConfig(code, config);
-        const ruleIds = result.messages.map((m) => m.ruleId).sort();
-        expect(ruleIds).toContain("traceability/require-traceability");
-        expect(ruleIds).toContain("traceability/require-story-annotation");
-    });
-    it("[REQ-CONFIG-PRESETS] strict preset also enables traceability rules via documented usage", async () => {
-        const config = [baseConfig, ...index_1.configs.strict];
-        const code = "function bar() {}";
-        const result = await lintTextWithConfig(code, config);
-        const ruleIds = result.messages.map((m) => m.ruleId).sort();
-        expect(ruleIds).toContain("traceability/require-traceability");
-        expect(ruleIds).toContain("traceability/require-story-annotation");
-    });
-});

package/lib/tests/config/require-story-annotation-config.test.d.ts

@@ -1,10 +0,0 @@
-/**
- * Tests for the require-story-annotation rule schema configuration.
- *
- * Verifies that the ESLint rule options for require-story-annotation
- * define the expected schema properties and constraints.
- *
- * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- * @supports docs/stories/002.0-DEV-ESLINT-CONFIG.story.md REQ-RULE-OPTIONS
- */
-export {};

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

@@ -1,26 +0,0 @@
-"use strict";
-/* eslint-disable traceability/valid-annotation-format */
-/**
- * Tests for the require-story-annotation rule schema configuration.
- *
- * Verifies that the ESLint rule options for require-story-annotation
- * define the expected schema properties and constraints.
- *
- * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
- * @supports docs/stories/002.0-DEV-ESLINT-CONFIG.story.md REQ-RULE-OPTIONS
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const require_story_annotation_1 = __importDefault(require("../../src/rules/require-story-annotation"));
-/** @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md */
-describe("ESLint Configuration Rule Options (Story 002.0-DEV-ESLINT-CONFIG)", () => {
-    it("[REQ-RULE-OPTIONS] require-story-annotation schema defines expected properties", () => {
-        const schema = require_story_annotation_1.default.meta.schema[0];
-        expect(schema.properties).toHaveProperty("scope");
-        expect(schema.properties).toHaveProperty("exportPriority");
-        expect(schema.properties).toHaveProperty("annotationPlacement");
-        expect(schema.additionalProperties).toBe(false);
-    });
-});

package/lib/tests/fixtures/stale/example.js

@@ -1,4 +0,0 @@
-"use strict";
-/* eslint-disable traceability/valid-annotation-format */
-// Sample code with stale annotation
-// @story docs/stories/non-existent.story.md

package/lib/tests/fixtures/update/example.js

@@ -1,4 +0,0 @@
-"use strict";
-/* eslint-disable traceability/valid-annotation-format */
-// Sample code with annotation to update
-// @story docs/stories/old.story.md

package/lib/tests/fixtures/valid-annotations/example.js

@@ -1,3 +0,0 @@
-"use strict";
-// Valid annotation
-// @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md

package/lib/tests/integration/annotation-placement-inside-prettier.integration.test.d.ts

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

package/lib/tests/integration/annotation-placement-inside-prettier.integration.test.js

@@ -1,133 +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 annotationPlacement: "inside" across multiple branch types.
- * @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
- * @supports docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md REQ-PRETTIER-STABLE REQ-INSIDE-BRACE-PLACEMENT REQ-PLACEMENT-CONFIG
- */
-const path_1 = __importDefault(require("path"));
-const child_process_1 = require("child_process");
-const prettier_test_helpers_1 = require("./prettier-test-helpers");
-describe("annotationPlacement: 'inside' with Prettier (Story 028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION)", () => {
-    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 buildInsidePlacementArgs(stdinFilename) {
-        return [
-            "--no-config-lookup",
-            "--config",
-            configPath,
-            "--stdin",
-            "--stdin-filename",
-            stdinFilename,
-            "--rule",
-            "no-unused-vars:off",
-            "--rule",
-            "no-magic-numbers:off",
-            "--rule",
-            "no-undef:off",
-            "--rule",
-            "no-console:off",
-            "--rule",
-            'traceability/require-branch-annotation:["error",{"annotationPlacement":"inside"}]',
-        ];
-    }
-    function runEslintWithInsidePlacement(code, _filename) {
-        // Pin stdin filename to a tsconfig-included path to satisfy @typescript-eslint/parser's project lookup in these integration tests.
-        const args = buildInsidePlacementArgs("src/annotation-placement-inside.ts");
-        return (0, child_process_1.spawnSync)(process.execPath, [eslintCliPath, ...args], {
-            encoding: "utf-8",
-            input: code,
-        });
-    }
-    function formatWithPrettier(source) {
-        return (0, prettier_test_helpers_1.formatWithPrettier)(source, { parser: "typescript" });
-    }
-    it("[REQ-PRETTIER-STABLE][REQ-INSIDE-BRACE-PLACEMENT] accepts formatted code with inside-brace annotations for if/else and loops", () => {
-        const original = `
-function demo(value: number) {
-  if (value > 0) {
-    // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-    // @req REQ-IF-INSIDE
-    console.log('positive');
-  } else if (value < 0) {
-    // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-    // @req REQ-ELSE-IF-INSIDE
-    console.log('negative');
-  } else {
-    // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-    // @req REQ-ELSE-INSIDE
-    console.log('zero');
-  }
-
-  for (const item of [1, 2, 3]) {
-    // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-    // @req REQ-LOOP-INSIDE
-    console.log(item);
-  }
-}
-`;
-        const formatted = formatWithPrettier(original);
-        const result = runEslintWithInsidePlacement(formatted, "annotation-placement-inside-if-loop.ts");
-        expect(result.stdout).not.toContain("traceability/require-branch-annotation");
-        expect([0, 1]).toContain(result.status);
-    });
-    it("[REQ-PRETTIER-STABLE][REQ-INSIDE-BRACE-PLACEMENT] accepts formatted code with inside-brace annotations for try/finally and catch", () => {
-        const original = `
-function demoTry(flag: boolean) {
-  try {
-    // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-    // @req REQ-TRY-INSIDE
-    if (flag) {
-      throw new Error('boom');
-    }
-  } catch (error) {
-    // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-    // @req REQ-CATCH-INSIDE
-    console.error(error);
-  } finally {
-    // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-    // @req REQ-FINALLY-INSIDE
-    console.log('cleanup');
-  }
-}
-`;
-        const formatted = formatWithPrettier(original);
-        const result = runEslintWithInsidePlacement(formatted, "annotation-placement-inside-try.ts");
-        expect(result.stdout).not.toContain("traceability/require-branch-annotation");
-        expect([0, 1]).toContain(result.status);
-    });
-    it("[REQ-PRETTIER-STABLE][REQ-INSIDE-BRACE-PLACEMENT] accepts formatted code with inside-brace annotations for switch cases", () => {
-        const original = `
-function demoSwitch(status: 'pending' | 'done' | 'other') {
-  switch (status) {
-    case 'pending': {
-      // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-      // @req REQ-SWITCH-PENDING-INSIDE
-      console.log('pending');
-      break;
-    }
-    case 'done': {
-      // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-      // @req REQ-SWITCH-DONE-INSIDE
-      console.log('done');
-      break;
-    }
-    default: {
-      // @story docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md
-      // @req REQ-SWITCH-DEFAULT-INSIDE
-      console.log('other');
-    }
-  }
-}
-`;
-        const formatted = formatWithPrettier(original);
-        const result = runEslintWithInsidePlacement(formatted, "annotation-placement-inside-switch.ts");
-        expect(result.stdout).not.toContain("traceability/require-branch-annotation");
-        expect([0, 1]).toContain(result.status);
-    });
-});

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

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