eslint-plugin-traceability 1.11.1 → 1.11.2

package/CHANGELOG.md

@@ -1,9 +1,9 @@
-## [1.11.1](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.11.0...v1.11.1) (2025-12-05)
+## [1.11.2](https://github.com/voder-ai/eslint-plugin-traceability/compare/v1.11.1...v1.11.2) (2025-12-06)
 
 
 ### Bug Fixes
 
-* expose valid-annotation-format autofix toggle and align docs ([32e7636](https://github.com/voder-ai/eslint-plugin-traceability/commit/32e7636e9b8f784b84f694a13e9e06d6120e38b3))
+* ignore inline-code annotation references in comment normalization ([118d743](https://github.com/voder-ai/eslint-plugin-traceability/commit/118d743ff8c8bf1dcb0854b898480c641cc727c8))
 
 # Changelog
 

package/README.md

@@ -242,4 +242,4 @@ For the canonical, user-facing security policy (including how to report vulnerab
 - Contribution guide: <https://github.com/voder-ai/eslint-plugin-traceability/blob/main/CONTRIBUTING.md>
 - Issue tracker: <https://github.com/voder-ai/eslint-plugin-traceability/issues>
 - Changelog: [CHANGELOG.md](CHANGELOG.md)
-- Versioning and Releases: This project uses semantic-release for automated versioning. The authoritative list of published versions and release notes is on GitHub Releases: <https://github.com/voder-ai/eslint-plugin-traceability/releases>
+- Versioning and Releases: This project uses semantic-release for automated versioning. The authoritative list of published versions and release notes is on GitHub Releases: <https://github.com/voder-ai/eslint-plugin-traceability/releases>

package/lib/src/index.d.ts

@@ -11,16 +11,27 @@ import type { Rule } from "eslint";
  */
 import { detectStaleAnnotations, updateAnnotationReferences, batchUpdateAnnotations, verifyAnnotations, generateMaintenanceReport } from "./maintenance";
 /**
- * @story docs/stories/002.0-DYNAMIC-RULE-LOADING.story.md
+ * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
  * @req REQ-RULE-LIST - Enumerate supported rule file names for plugin discovery
  */
 declare const RULE_NAMES: readonly ["require-story-annotation", "require-req-annotation", "require-branch-annotation", "valid-annotation-format", "valid-story-reference", "valid-req-reference", "prefer-implements-annotation", "require-test-traceability"];
 type RuleName = (typeof RULE_NAMES)[number];
 declare const rules: Record<RuleName, Rule.RuleModule>;
+/**
+ * Plugin metadata used by ESLint for debugging and caching.
+ *
+ * @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-PLUGIN-STRUCTURE REQ-NPM-PACKAGE
+ */
+declare const pluginMeta: {
+    readonly name: string;
+    readonly version: string;
+    readonly namespace: "traceability";
+};
 declare const plugin: {
     rules: typeof rules;
     configs?: unknown;
     maintenance?: unknown;
+    meta?: typeof pluginMeta;
 };
 /**
  * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md

package/lib/src/index.js

@@ -7,7 +7,7 @@ exports.maintenance = exports.configs = exports.rules = void 0;
  */
 const maintenance_1 = require("./maintenance");
 /**
- * @story docs/stories/002.0-DYNAMIC-RULE-LOADING.story.md
+ * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
  * @req REQ-RULE-LIST - Enumerate supported rule file names for plugin discovery
  */
 const RULE_NAMES = [
@@ -24,18 +24,18 @@ const rules = {};
 exports.rules = rules;
 RULE_NAMES.forEach(
 /**
- * @story docs/stories/002.0-DYNAMIC-RULE-LOADING.story.md
+ * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
  * @req REQ-DYNAMIC-LOADING - Support dynamic rule loading by name at runtime
  * @param {RuleName} name - Rule file base name used to discover and load rule module
  */
 (name) => {
     /**
-     * @story docs/stories/002.0-DYNAMIC-RULE-LOADING.story.md
+     * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
      * @req REQ-DYNAMIC-LOADING - Support dynamic rule loading by name at runtime
      */
     try {
         /**
-         * @story docs/stories/002.0-DYNAMIC-RULE-LOADING.story.md
+         * @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md
          * @req REQ-DYNAMIC-LOADING - Support dynamic rule loading by name at runtime
          */
         // Dynamically require rule module
@@ -45,11 +45,11 @@ RULE_NAMES.forEach(
     }
     catch (error) {
         /**
-         * @story docs/stories/003.0-RULE-LOAD-ERROR-HANDLING.story.md
+         * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
          * @req REQ-ERROR-HANDLING - Provide fallback rule module and surface errors when rule loading fails
          */
         /**
-         * @story docs/stories/003.0-RULE-LOAD-ERROR-HANDLING.story.md
+         * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
          * @req REQ-ERROR-HANDLING - Provide fallback rule module and surface errors when rule loading fails
          */
         console.error(`[eslint-plugin-traceability] Failed to load rule "${name}": ${error.message}`);
@@ -74,8 +74,45 @@ RULE_NAMES.forEach(
         };
     }
 });
+/**
+ * Plugin metadata used by ESLint for debugging and caching.
+ *
+ * @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-PLUGIN-STRUCTURE REQ-NPM-PACKAGE
+ */
+const pluginMeta = (() => {
+    let pkg = {};
+    try {
+        // When running from built output (lib/src/index.js)
+        // this resolves to the package.json at the project root.
+        // @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-NPM-PACKAGE
+        pkg = require("../../package.json");
+    }
+    catch {
+        try {
+            // When running via the TypeScript sources (src/index.ts) in this repo,
+            // fall back to resolving package.json one level up from src/.
+            // @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-NPM-PACKAGE
+            pkg = require("../package.json");
+        }
+        catch {
+            // As a last resort (tests, unusual environments), provide sensible
+            // defaults so that plugin loading never fails just for metadata.
+            // @supports docs/stories/001.0-DEV-PLUGIN-SETUP.story.md REQ-PLUGIN-STRUCTURE
+            pkg = {
+                name: "eslint-plugin-traceability",
+                version: "0.0.0-development",
+            };
+        }
+    }
+    return {
+        name: pkg.name ?? "eslint-plugin-traceability",
+        version: pkg.version ?? "0.0.0-development",
+        namespace: "traceability",
+    };
+})();
 const plugin = {
     rules,
+    meta: pluginMeta,
 };
 /**
  * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md

package/lib/src/maintenance/commands.js

@@ -9,7 +9,7 @@ exports.handleUpdate = handleUpdate;
  * Subcommand handlers for the traceability-maint CLI.
  *
  * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
- * @req REQ-MAINT-DETECT - CLI support for detection of stale annotations
+ * @req REQ-MAINT-DETECT - CLI support for detection of stale annotations.
  * @req REQ-MAINT-VERIFY - CLI support for verification of annotations
  * @req REQ-MAINT-REPORT - CLI support for human-readable reports
  * @req REQ-MAINT-UPDATE - CLI support for updating annotation references
@@ -34,8 +34,7 @@ function handleDetect(normalized) {
     const root = flags.root;
     const stale = (0, detect_1.detectStaleAnnotations)(root);
     if (flags.json) {
-        // @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
-        // @req REQ-MAINT-REPORT - JSON-friendly output for tooling integration
+        // Emit JSON output to support consumption by external tools and scripts.
         console.log(JSON.stringify({ root, stale }));
     }
     else if (stale.length === 0) {

package/lib/src/maintenance/update.js

@@ -42,20 +42,7 @@ const utils_1 = require("./utils");
  * @req REQ-MAINT-UPDATE
  */
 function processFileForAnnotationUpdates(fullPath, regex, newPath, replacementCountRef) {
-    const stat = fs.statSync(fullPath);
-    /**
-     * Skip non-files in iteration
-     * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
-     * @req REQ-MAINT-UPDATE
-     */
-    /**
-     * Skip entries that are not regular files (e.g., directories)
-     * @story docs/stories/009.0-DEV-MAINTENANCE-TOOLS.story.md
-     * @req REQ-MAINT-UPDATE
-     */
-    if (!stat.isFile())
-        return;
-    const content = fs.readFileSync(fullPath, "utf8");
+    const content = fs.readFileSync(fullPath, "utf8"); // getAllFiles already returns regular files
     const newContent = content.replace(regex, 
     /**
      * Replacement callback to update annotation references

package/lib/src/rules/helpers/require-story-core.d.ts

@@ -1,23 +1,31 @@
 /**
  * Create a fixer function that inserts a @story annotation before the target node.
+ * This fixer is responsible for placing the annotation immediately before the
+ * resolved target node in the source code.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-AUTOFIX - Provide automatic fix function for missing @story annotations
  */
 export declare function createAddStoryFix(target: any, annotationTemplate: string): (fixer: any) => any;
 /**
  * Create a fixer function for class method annotations.
+ * This helper ensures that the @story annotation is inserted with appropriate
+ * indentation and placement before a class method declaration.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-AUTOFIX - Provide automatic fix for class method annotations
  */
 export declare function createMethodFix(node: any, annotationTemplate: string): (fixer: any) => any;
 /**
  * Default set of node types to check for missing @story annotations.
+ * This default scope covers common function-like declarations used in typical
+ * TypeScript and JavaScript codebases.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Provide sensible default scope for rule checks
  */
 export declare const DEFAULT_SCOPE: string[];
 /**
  * Path to the story file for function-annotation helpers.
+ * This constant centralizes the reference to the canonical documentation story
+ * used by these helpers.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Provide a single source of truth for the canonical story path used by helper modules
  */
@@ -48,8 +56,8 @@ type ReportDeps = {
 };
 /**
  * Core helper to report a missing @story annotation for a function-like node.
- * Delegates actual behavior to injected dependencies so higher-level helpers
- * can remain small while sharing error-reporting behavior.
+ * This reporting utility delegates behavior to injected dependencies so that
+ * higher-level helpers can stay small while sharing error-reporting logic.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
  * @story docs/stories/008.0-DEV-AUTO-FIX.story.md
@@ -64,8 +72,8 @@ export declare function coreReportMissing(deps: ReportDeps, context: Rule.RuleCo
 }): void;
 /**
  * Core helper to report a missing @story annotation for a method-like node.
- * Delegates actual behavior to injected dependencies while keeping this
- * module focused on core error-reporting behavior.
+ * This method-focused reporting utility uses injected dependencies while
+ * keeping this module centered on core error-reporting behavior.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
  * @story docs/stories/008.0-DEV-AUTO-FIX.story.md

package/lib/src/rules/helpers/require-story-core.js

@@ -5,62 +5,77 @@ exports.createAddStoryFix = createAddStoryFix;
 exports.createMethodFix = createMethodFix;
 exports.coreReportMissing = coreReportMissing;
 exports.coreReportMethod = coreReportMethod;
+/**
+ * Compute the insertion start offset for inserting annotations before a node.
+ * This helper ensures we insert before any export wrapper when present, while
+ * remaining resilient to malformed or unexpected AST structures.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-AUTOFIX
+ * @req REQ-AUTOFIX-SAFE
+ */
+function getInsertionStart(candidate) {
+    if (!candidate || typeof candidate !== "object") {
+        return 0;
+    }
+    const parent = candidate.parent;
+    if (parent &&
+        (parent.type === "ExportNamedDeclaration" ||
+            parent.type === "ExportDefaultDeclaration") &&
+        Array.isArray(parent.range) &&
+        typeof parent.range[0] === "number") {
+        return parent.range[0];
+    }
+    if (Array.isArray(candidate.range) &&
+        typeof candidate.range[0] === "number") {
+        return candidate.range[0];
+    }
+    return 0;
+}
 /**
  * Create a fixer function that inserts a @story annotation before the target node.
+ * This fixer is responsible for placing the annotation immediately before the
+ * resolved target node in the source code.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-AUTOFIX - Provide automatic fix function for missing @story annotations
  */
 function createAddStoryFix(target, annotationTemplate) {
     /**
      * Fixer that inserts a @story annotation before the target node.
+     * This inner fixer is used by ESLint to apply the actual code modification.
      * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
      * @req REQ-AUTOFIX - Provide automatic fix function for missing @story annotations
      */
     function addStoryFixer(fixer) {
-        const start = target && typeof target === "object"
-            ? target.parent &&
-                (target.parent.type === "ExportNamedDeclaration" ||
-                    target.parent.type === "ExportDefaultDeclaration") &&
-                Array.isArray(target.parent.range) &&
-                typeof target.parent.range[0] === "number"
-                ? target.parent.range[0]
-                : Array.isArray(target.range) && typeof target.range[0] === "number"
-                    ? target.range[0]
-                    : 0
-            : 0;
+        const start = getInsertionStart(target);
         return fixer.insertTextBeforeRange([start, start], `${annotationTemplate}\n`);
     }
     return addStoryFixer;
 }
 /**
  * Create a fixer function for class method annotations.
+ * This helper ensures that the @story annotation is inserted with appropriate
+ * indentation and placement before a class method declaration.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-AUTOFIX - Provide automatic fix for class method annotations
  */
 function createMethodFix(node, annotationTemplate) {
     /**
      * Fixer that inserts a @story annotation before a method node.
+     * This inner fixer handles inserting the annotation with method-friendly
+     * formatting and spacing.
      * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
      * @req REQ-AUTOFIX - Provide automatic fix for class method annotations
      */
     function methodFixer(fixer) {
-        const start = node && typeof node === "object"
-            ? node.parent &&
-                (node.parent.type === "ExportNamedDeclaration" ||
-                    node.parent.type === "ExportDefaultDeclaration") &&
-                Array.isArray(node.parent.range) &&
-                typeof node.parent.range[0] === "number"
-                ? node.parent.range[0]
-                : Array.isArray(node.range) && typeof node.range[0] === "number"
-                    ? node.range[0]
-                    : 0
-            : 0;
+        const start = getInsertionStart(node);
         return fixer.insertTextBeforeRange([start, start], `${annotationTemplate}\n  `);
     }
     return methodFixer;
 }
 /**
  * Default set of node types to check for missing @story annotations.
+ * This default scope covers common function-like declarations used in typical
+ * TypeScript and JavaScript codebases.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Provide sensible default scope for rule checks
  */
@@ -73,6 +88,8 @@ exports.DEFAULT_SCOPE = [
 ];
 /**
  * Path to the story file for function-annotation helpers.
+ * This constant centralizes the reference to the canonical documentation story
+ * used by these helpers.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Provide a single source of truth for the canonical story path used by helper modules
  */
@@ -83,8 +100,8 @@ exports.STORY_PATH = "docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md";
 exports.EXPORT_PRIORITY_VALUES = ["all", "exported", "non-exported"];
 /**
  * Core helper to report a missing @story annotation for a function-like node.
- * Delegates actual behavior to injected dependencies so higher-level helpers
- * can remain small while sharing error-reporting behavior.
+ * This reporting utility delegates behavior to injected dependencies so that
+ * higher-level helpers can stay small while sharing error-reporting logic.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
  * @story docs/stories/008.0-DEV-AUTO-FIX.story.md
@@ -118,14 +135,20 @@ function coreReportMissing(deps, context, sourceCode, config) {
             ],
         });
     }
-    catch {
-        /* noop */
+    catch (error) {
+        // Intentionally swallow unexpected helper errors so traceability checks never
+        // break lint runs. When TRACEABILITY_DEBUG=1 is set, log a debug message to
+        // help diagnose misbehaving helpers in local development without affecting
+        // normal CI or production usage.
+        if (process.env.TRACEABILITY_DEBUG === "1") {
+            console.error("[traceability] coreReportMissing failed for node", error?.message ?? error);
+        }
     }
 }
 /**
  * Core helper to report a missing @story annotation for a method-like node.
- * Delegates actual behavior to injected dependencies while keeping this
- * module focused on core error-reporting behavior.
+ * This method-focused reporting utility uses injected dependencies while
+ * keeping this module centered on core error-reporting behavior.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
  * @story docs/stories/008.0-DEV-AUTO-FIX.story.md
@@ -159,7 +182,13 @@ function coreReportMethod(deps, context, sourceCode, config) {
             ],
         });
     }
-    catch {
-        /* noop */
+    catch (error) {
+        // Intentionally swallow unexpected helper errors so traceability checks never
+        // break lint runs. When TRACEABILITY_DEBUG=1 is set, log a debug message to
+        // help diagnose misbehaving helpers in local development without affecting
+        // normal CI or production usage.
+        if (process.env.TRACEABILITY_DEBUG === "1") {
+            console.error("[traceability] coreReportMethod failed for node", error?.message ?? error);
+        }
     }
 }

package/lib/src/rules/helpers/require-story-helpers.d.ts

@@ -12,48 +12,36 @@ import { linesBeforeHasStory, parentChainHasStory, fallbackTextBeforeHasStory }
 import { getNodeName } from "./require-story-utils";
 import { DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES, STORY_PATH } from "./require-story-core";
 /**
- * Derive the annotation template, optionally using an override.
- * When override is a non-empty string, its trimmed value is used.
- * Otherwise, the default template is returned.
+ * Shared configuration helpers
  */
+interface ReportOptions {
+    annotationTemplateOverride?: string;
+    autoFixToggle?: boolean;
+}
 declare function getAnnotationTemplate(override?: string): string;
-/**
- * Determine whether auto-fix should be applied.
- * Explicit false disables auto-fix; all other values enable it.
- */
 declare function shouldApplyAutoFix(autoFix: boolean | undefined): boolean;
 /**
  * Determine if a node is in an export declaration
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Check node ancestry to find export declarations
- * @param {any} node - AST node to check for export ancestry
- * @returns {boolean} true if node is within an export declaration
  */
 declare function isExportedNode(node: any): boolean;
 /**
  * Check whether the JSDoc associated with node contains @story
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Extract JSDoc based detection into helper
- * @param {any} sourceCode - ESLint sourceCode object
- * @param {any} node - AST node to inspect
- * @returns {boolean} true if JSDoc contains @story
  */
 declare function jsdocHasStory(sourceCode: any, node: any): boolean;
 /**
  * Check whether comments returned by sourceCode.getCommentsBefore contain @story
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Extract comment-before detection into helper
- * @param {any} sourceCode - ESLint sourceCode object
- * @param {any} node - AST node to inspect
- * @returns {boolean} true if any preceding comment contains @story
  */
 declare function commentsBeforeHasStory(sourceCode: any, node: any): boolean;
 /**
  * Check whether leadingComments attached to the node contain @story
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Extract leadingComments detection into helper
- * @param {any} node - AST node to inspect
- * @returns {boolean} true if any leading comment contains @story
  */
 declare function leadingCommentsHasStory(node: any): boolean;
 /**
@@ -61,43 +49,21 @@ declare function leadingCommentsHasStory(node: any): boolean;
  * Consolidates a variety of heuristics through smaller helpers.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Detect existing story annotations in JSDoc or comments
- * @param {any} sourceCode - ESLint sourceCode object
- * @param {any} node - AST node to inspect for existing annotations
- * @returns {boolean} true if @story annotation already present
  */
 declare function hasStoryAnnotation(sourceCode: any, node: any): boolean;
 /**
  * Determine AST node where annotation should be inserted
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Determine correct insertion target for annotation
- * @param {any} sourceCode - ESLint sourceCode object (unused but kept for parity)
- * @param {any} node - function-like AST node to resolve target for
- * @returns {any} AST node that should receive the annotation
  */
 declare function resolveTargetNode(sourceCode: any, node: any): any;
 /**
  * Small utility to walk the node and its parents to extract an Identifier or key name.
- * Walks up the parent chain and inspects common properties (id, key, name, Identifier nodes).
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED - Walk node and parents to find Identifier/Key name
- * @param {any} node - AST node to extract a name from
- * @returns {string} extracted name or "(anonymous)" when no name found
  */
 declare function extractName(node: any): string;
-/**
- * Check if this node is within scope and matches exportPriority
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED - Determine whether a node should be processed by rule
- * @param {any} node - AST node to evaluate
- * @param {string[]} scope - allowed node types
- * @param {string} [exportPriority='all'] - 'all' | 'exported' | 'non-exported' (default: 'all')
- * @returns {boolean} whether node should be processed
- */
 declare function shouldProcessNode(node: any, scope: string[], exportPriority?: string): boolean;
-interface ReportOptions {
-    annotationTemplateOverride?: string;
-    autoFixToggle?: boolean;
-}
 declare function reportMissing(context: Rule.RuleContext, sourceCode: any, config: {
     node: any;
     target?: any;
@@ -109,8 +75,8 @@ declare function reportMethod(context: Rule.RuleContext, sourceCode: any, config
     options?: ReportOptions;
 }): void;
 /**
- * Explicit exports for require-story-annotation consumers
+ * Explicit exports for require-story-annotation helpers.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED - Explicitly export helper functions and constants used by requiring modules
+ * @req REQ-ANNOTATION-REQUIRED
  */
 export { STORY_PATH, getAnnotationTemplate, shouldApplyAutoFix, isExportedNode, jsdocHasStory, commentsBeforeHasStory, leadingCommentsHasStory, hasStoryAnnotation, getNodeName, extractName, resolveTargetNode, shouldProcessNode, DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES, linesBeforeHasStory, parentChainHasStory, fallbackTextBeforeHasStory, reportMissing, reportMethod, };