eslint-plugin-traceability 1.1.0 → 1.1.1

package/.github/workflows/ci-cd.yml

@@ -82,6 +82,9 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
+      - name: Build project
+        run: npm run build
+
       - name: Release with semantic-release
         run: npx semantic-release
         env:

package/.releaserc.json

@@ -9,7 +9,12 @@
         "changelogFile": "CHANGELOG.md"
       }
     ],
-    "@semantic-release/npm",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true
+      }
+    ],
     "@semantic-release/github"
   ]
 }

package/CHANGELOG.md

@@ -1,9 +1,10 @@
-# [1.1.0](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.0.6...v1.1.0) (2025-11-17)
+## [1.1.1](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.1.0...v1.1.1) (2025-11-17)
 
 
-### Features
+### Bug Fixes
 
-* add local smoke test script and fix CI smoke test to use CommonJS ([2323802](https://github.com/voder-ai/eslint-plugin-traceability/commit/23238024be18b870deac1f53ecc3ed935fbc0dc6))
+* build project before semantic-release and improve smoke test to use npm pack ([e9621d3](https://github.com/voder-ai/eslint-plugin-traceability/commit/e9621d365bf8ebd36e507052c88ead787703cb17))
+* remove tarballDir option from semantic-release npm plugin ([e3703e5](https://github.com/voder-ai/eslint-plugin-traceability/commit/e3703e5a79e6b0784b98f8f4996083a6040a5fb4))
 
 # Changelog
 

package/lib/src/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * ESLint Traceability Plugin
+ * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
+ * @req REQ-PLUGIN-STRUCTURE - Provide foundational plugin export and registration
+ */
+export declare const rules: {
+    "require-story-annotation": any;
+    "require-req-annotation": any;
+    "require-branch-annotation": any;
+    "valid-annotation-format": any;
+    "valid-story-reference": import("eslint").Rule.RuleModule;
+    "valid-req-reference": import("eslint").Rule.RuleModule;
+};
+export declare const configs: {
+    recommended: {
+        plugins: {
+            traceability: {};
+        };
+        rules: {
+            "traceability/require-story-annotation": string;
+            "traceability/require-req-annotation": string;
+            "traceability/require-branch-annotation": string;
+            "traceability/valid-annotation-format": string;
+            "traceability/valid-story-reference": string;
+            "traceability/valid-req-reference": string;
+        };
+    }[];
+    strict: {
+        plugins: {
+            traceability: {};
+        };
+        rules: {
+            "traceability/require-story-annotation": string;
+            "traceability/require-req-annotation": string;
+            "traceability/require-branch-annotation": string;
+            "traceability/valid-annotation-format": string;
+            "traceability/valid-story-reference": string;
+            "traceability/valid-req-reference": string;
+        };
+    }[];
+};
+declare const _default: {
+    rules: {
+        "require-story-annotation": any;
+        "require-req-annotation": any;
+        "require-branch-annotation": any;
+        "valid-annotation-format": any;
+        "valid-story-reference": import("eslint").Rule.RuleModule;
+        "valid-req-reference": import("eslint").Rule.RuleModule;
+    };
+    configs: {
+        recommended: {
+            plugins: {
+                traceability: {};
+            };
+            rules: {
+                "traceability/require-story-annotation": string;
+                "traceability/require-req-annotation": string;
+                "traceability/require-branch-annotation": string;
+                "traceability/valid-annotation-format": string;
+                "traceability/valid-story-reference": string;
+                "traceability/valid-req-reference": string;
+            };
+        }[];
+        strict: {
+            plugins: {
+                traceability: {};
+            };
+            rules: {
+                "traceability/require-story-annotation": string;
+                "traceability/require-req-annotation": string;
+                "traceability/require-branch-annotation": string;
+                "traceability/valid-annotation-format": string;
+                "traceability/valid-story-reference": string;
+                "traceability/valid-req-reference": string;
+            };
+        }[];
+    };
+};
+export default _default;

package/lib/src/index.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * ESLint Traceability Plugin
+ * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
+ * @req REQ-PLUGIN-STRUCTURE - Provide foundational plugin export and registration
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = exports.rules = void 0;
+const require_story_annotation_1 = __importDefault(require("./rules/require-story-annotation"));
+const require_req_annotation_1 = __importDefault(require("./rules/require-req-annotation"));
+const require_branch_annotation_1 = __importDefault(require("./rules/require-branch-annotation"));
+const valid_annotation_format_1 = __importDefault(require("./rules/valid-annotation-format"));
+const valid_story_reference_1 = __importDefault(require("./rules/valid-story-reference"));
+const valid_req_reference_1 = __importDefault(require("./rules/valid-req-reference"));
+exports.rules = {
+    "require-story-annotation": require_story_annotation_1.default,
+    "require-req-annotation": require_req_annotation_1.default,
+    "require-branch-annotation": require_branch_annotation_1.default,
+    "valid-annotation-format": valid_annotation_format_1.default,
+    "valid-story-reference": valid_story_reference_1.default,
+    "valid-req-reference": valid_req_reference_1.default,
+};
+exports.configs = {
+    recommended: [
+        {
+            plugins: {
+                traceability: {},
+            },
+            rules: {
+                "traceability/require-story-annotation": "error",
+                "traceability/require-req-annotation": "error",
+                "traceability/require-branch-annotation": "error",
+                "traceability/valid-annotation-format": "error",
+                "traceability/valid-story-reference": "error",
+                "traceability/valid-req-reference": "error",
+            },
+        },
+    ],
+    strict: [
+        {
+            plugins: {
+                traceability: {},
+            },
+            rules: {
+                "traceability/require-story-annotation": "error",
+                "traceability/require-req-annotation": "error",
+                "traceability/require-branch-annotation": "error",
+                "traceability/valid-annotation-format": "error",
+                "traceability/valid-story-reference": "error",
+                "traceability/valid-req-reference": "error",
+            },
+        },
+    ],
+};
+exports.default = { rules: exports.rules, configs: exports.configs };

package/lib/src/maintenance/batch.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Batch update annotations and verify references
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-BATCH - Perform batch updates
+ * @req REQ-MAINT-VERIFY - Verify annotation references
+ */
+export declare function batchUpdateAnnotations(codebasePath: string, mappings: {
+    oldPath: string;
+    newPath: string;
+}[]): number;
+/**
+ * Verify annotation references in codebase after maintenance operations
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-VERIFY - Verify annotation references
+ */
+export declare function verifyAnnotations(codebasePath: string): boolean;

package/lib/src/maintenance/batch.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.batchUpdateAnnotations = batchUpdateAnnotations;
+exports.verifyAnnotations = verifyAnnotations;
+const update_1 = require("./update");
+const detect_1 = require("./detect");
+/**
+ * Batch update annotations and verify references
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-BATCH - Perform batch updates
+ * @req REQ-MAINT-VERIFY - Verify annotation references
+ */
+function batchUpdateAnnotations(codebasePath, mappings) {
+    let totalUpdated = 0;
+    for (const { oldPath, newPath } of mappings) {
+        totalUpdated += (0, update_1.updateAnnotationReferences)(codebasePath, oldPath, newPath);
+    }
+    return totalUpdated;
+}
+/**
+ * Verify annotation references in codebase after maintenance operations
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-VERIFY - Verify annotation references
+ */
+function verifyAnnotations(codebasePath) {
+    const staleAnnotations = (0, detect_1.detectStaleAnnotations)(codebasePath);
+    return staleAnnotations.length === 0;
+}

package/lib/src/maintenance/detect.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Detect stale annotation references that point to moved or deleted story files
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-DETECT - Detect stale annotation references
+ */
+export declare function detectStaleAnnotations(codebasePath: string): string[];

package/lib/src/maintenance/detect.js

@@ -0,0 +1,69 @@
+"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 });
+exports.detectStaleAnnotations = detectStaleAnnotations;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const utils_1 = require("./utils");
+/**
+ * Detect stale annotation references that point to moved or deleted story files
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-DETECT - Detect stale annotation references
+ */
+function detectStaleAnnotations(codebasePath) {
+    if (!fs.existsSync(codebasePath) ||
+        !fs.statSync(codebasePath).isDirectory()) {
+        return [];
+    }
+    const cwd = process.cwd();
+    const baseDir = path.resolve(cwd, codebasePath);
+    const stale = new Set();
+    const files = (0, utils_1.getAllFiles)(codebasePath);
+    for (const file of files) {
+        const content = fs.readFileSync(file, "utf8");
+        const regex = /@story\s+([^\s]+)/g;
+        let match;
+        while ((match = regex.exec(content)) !== null) {
+            const storyPath = match[1];
+            const storyProjectPath = path.resolve(cwd, storyPath);
+            const storyCodebasePath = path.resolve(baseDir, storyPath);
+            if (!fs.existsSync(storyProjectPath) &&
+                !fs.existsSync(storyCodebasePath)) {
+                stale.add(storyPath);
+            }
+        }
+    }
+    return Array.from(stale);
+}

package/lib/src/maintenance/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Maintenance Tools Module
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-DETECT
+ * @req REQ-MAINT-UPDATE
+ * @req REQ-MAINT-BATCH
+ * @req REQ-MAINT-VERIFY
+ * @req REQ-MAINT-REPORT
+ * @req REQ-MAINT-SAFE
+ */
+export { detectStaleAnnotations } from "./detect";
+export { updateAnnotationReferences } from "./update";
+export { batchUpdateAnnotations, verifyAnnotations } from "./batch";
+export { generateMaintenanceReport } from "./report";

package/lib/src/maintenance/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMaintenanceReport = exports.verifyAnnotations = exports.batchUpdateAnnotations = exports.updateAnnotationReferences = exports.detectStaleAnnotations = void 0;
+/**
+ * Maintenance Tools Module
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-DETECT
+ * @req REQ-MAINT-UPDATE
+ * @req REQ-MAINT-BATCH
+ * @req REQ-MAINT-VERIFY
+ * @req REQ-MAINT-REPORT
+ * @req REQ-MAINT-SAFE
+ */
+var detect_1 = require("./detect");
+Object.defineProperty(exports, "detectStaleAnnotations", { enumerable: true, get: function () { return detect_1.detectStaleAnnotations; } });
+var update_1 = require("./update");
+Object.defineProperty(exports, "updateAnnotationReferences", { enumerable: true, get: function () { return update_1.updateAnnotationReferences; } });
+var batch_1 = require("./batch");
+Object.defineProperty(exports, "batchUpdateAnnotations", { enumerable: true, get: function () { return batch_1.batchUpdateAnnotations; } });
+Object.defineProperty(exports, "verifyAnnotations", { enumerable: true, get: function () { return batch_1.verifyAnnotations; } });
+var report_1 = require("./report");
+Object.defineProperty(exports, "generateMaintenanceReport", { enumerable: true, get: function () { return report_1.generateMaintenanceReport; } });

package/lib/src/maintenance/report.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generate a report of maintenance operations performed
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-REPORT - Generate maintenance report
+ * @req REQ-MAINT-SAFE - Ensure operations are safe and reversible
+ */
+export declare function generateMaintenanceReport(codebasePath: string): string;

package/lib/src/maintenance/report.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMaintenanceReport = generateMaintenanceReport;
+const detect_1 = require("./detect");
+/**
+ * Generate a report of maintenance operations performed
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-REPORT - Generate maintenance report
+ * @req REQ-MAINT-SAFE - Ensure operations are safe and reversible
+ */
+function generateMaintenanceReport(codebasePath) {
+    const staleAnnotations = (0, detect_1.detectStaleAnnotations)(codebasePath);
+    if (staleAnnotations.length === 0) {
+        return "";
+    }
+    return staleAnnotations.join("\n");
+}

package/lib/src/maintenance/update.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Update annotation references when story files are moved or renamed
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-UPDATE - Update annotation references
+ */
+export declare function updateAnnotationReferences(codebasePath: string, oldPath: string, newPath: string): number;

package/lib/src/maintenance/update.js

@@ -0,0 +1,67 @@
+"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 });
+exports.updateAnnotationReferences = updateAnnotationReferences;
+const fs = __importStar(require("fs"));
+const utils_1 = require("./utils");
+/**
+ * Update annotation references when story files are moved or renamed
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-UPDATE - Update annotation references
+ */
+function updateAnnotationReferences(codebasePath, oldPath, newPath) {
+    if (!fs.existsSync(codebasePath) ||
+        !fs.statSync(codebasePath).isDirectory()) {
+        return 0;
+    }
+    let replacementCount = 0;
+    const escapedOldPath = oldPath.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    const regex = new RegExp(`(@story\\s*)${escapedOldPath}`, "g");
+    const files = (0, utils_1.getAllFiles)(codebasePath);
+    for (const fullPath of files) {
+        const stat = fs.statSync(fullPath);
+        if (!stat.isFile())
+            continue;
+        const content = fs.readFileSync(fullPath, "utf8");
+        const newContent = content.replace(regex, (match, p1) => {
+            replacementCount++;
+            return `${p1}${newPath}`;
+        });
+        if (newContent !== content) {
+            fs.writeFileSync(fullPath, newContent, "utf8");
+        }
+    }
+    return replacementCount;
+}

package/lib/src/maintenance/utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Recursively retrieve all files in a directory.
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-UTILS - Extract common file traversal logic for maintenance tools
+ */
+export declare function getAllFiles(dir: string): string[];

package/lib/src/maintenance/utils.js

@@ -0,0 +1,64 @@
+"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 });
+exports.getAllFiles = getAllFiles;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/**
+ * Recursively retrieve all files in a directory.
+ * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
+ * @req REQ-MAINT-UTILS - Extract common file traversal logic for maintenance tools
+ */
+function getAllFiles(dir) {
+    const fileList = [];
+    if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
+        return fileList;
+    }
+    function traverse(currentDir) {
+        const entries = fs.readdirSync(currentDir);
+        for (const entry of entries) {
+            const fullPath = path.join(currentDir, entry);
+            const stat = fs.statSync(fullPath);
+            if (stat.isDirectory()) {
+                traverse(fullPath);
+            }
+            else if (stat.isFile()) {
+                fileList.push(fullPath);
+            }
+        }
+    }
+    traverse(dir);
+    return fileList;
+}

package/lib/src/rules/require-branch-annotation.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Rule to enforce @story and @req annotations on significant code branches
+ * @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+ * @req REQ-BRANCH-DETECTION - Detect significant code branches for traceability annotations
+ */
+declare const _default: any;
+export default _default;

package/lib/src/rules/require-branch-annotation.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Rule to enforce @story and @req annotations on significant code branches
+ * @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+ * @req REQ-BRANCH-DETECTION - Detect significant code branches for traceability annotations
+ */
+exports.default = {
+    meta: {
+        type: "problem",
+        docs: {
+            description: "Require @story and @req annotations on code branches",
+            recommended: "error",
+        },
+        fixable: "code",
+        messages: {
+            missingAnnotation: "Missing {{missing}} annotation on code branch",
+        },
+        schema: [],
+    },
+    create(context) {
+        const sourceCode = context.getSourceCode();
+        /**
+         * Helper to check a branch AST node for traceability annotations.
+         * @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+         * @req REQ-BRANCH-DETECTION - Detect significant code branches for traceability annotations
+         */
+        function checkBranch(node) {
+            // @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+            // @req REQ-BRANCH-DETECTION - Skip default switch cases during annotation checks
+            // skip default cases in switch
+            if (node.type === "SwitchCase" && node.test == null) {
+                return;
+            }
+            // collect comments before node
+            let comments = sourceCode.getCommentsBefore(node) || [];
+            // @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+            // @req REQ-BRANCH-DETECTION - Fallback scanning for SwitchCase when leading comments are absent
+            // fallback scanning for SwitchCase if no leading comment nodes
+            /* istanbul ignore if */
+            if (node.type === "SwitchCase" && comments.length === 0) {
+                const lines = sourceCode.lines;
+                const startLine = node.loc.start.line;
+                let i = startLine - 1;
+                const fallbackComments = [];
+                while (i > 0) {
+                    const lineText = lines[i - 1];
+                    if (/^\s*(\/\/|\/\*)/.test(lineText)) {
+                        fallbackComments.unshift(lineText.trim());
+                        i--;
+                    }
+                    else if (/^\s*$/.test(lineText)) {
+                        break;
+                    }
+                    else {
+                        break;
+                    }
+                }
+                comments = fallbackComments.map((text) => ({ value: text }));
+            }
+            const text = comments.map((c) => c.value).join(" ");
+            const missingStory = !/@story\b/.test(text);
+            const missingReq = !/@req\b/.test(text);
+            if (missingStory) {
+                const reportObj = {
+                    node,
+                    messageId: "missingAnnotation",
+                    data: { missing: "@story" },
+                };
+                if (node.type !== "CatchClause") {
+                    if (node.type === "SwitchCase") {
+                        const indent = " ".repeat(node.loc.start.column);
+                        reportObj.fix = (fixer) => fixer.insertTextBefore(node, `// @story <story-file>.story.md\n${indent}`);
+                    }
+                    else {
+                        reportObj.fix = (fixer) => fixer.insertTextBefore(node, `// @story <story-file>.story.md\n`);
+                    }
+                }
+                context.report(reportObj);
+            }
+            if (missingReq) {
+                const reportObj = {
+                    node,
+                    messageId: "missingAnnotation",
+                    data: { missing: "@req" },
+                };
+                if (!missingStory && node.type !== "CatchClause") {
+                    if (node.type === "SwitchCase") {
+                        const indent = " ".repeat(node.loc.start.column);
+                        reportObj.fix = (fixer) => fixer.insertTextBefore(node, `// @req <REQ-ID>\n${indent}`);
+                    }
+                    else {
+                        reportObj.fix = (fixer) => fixer.insertTextBefore(node, `// @req <REQ-ID>\n`);
+                    }
+                }
+                context.report(reportObj);
+            }
+        }
+        return {
+            IfStatement: checkBranch,
+            SwitchCase: checkBranch,
+            TryStatement: checkBranch,
+            CatchClause: checkBranch,
+            ForStatement: checkBranch,
+            ForOfStatement: checkBranch,
+            ForInStatement: checkBranch,
+            WhileStatement: checkBranch,
+            DoWhileStatement: checkBranch,
+        };
+    },
+};

package/lib/src/rules/require-req-annotation.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Rule to enforce @req annotation on functions
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Require @req annotation on functions
+ */
+declare const _default: any;
+export default _default;