eslint-plugin-traceability 1.11.0 → 1.11.2

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

@@ -10,66 +10,38 @@
 import type { Rule } from "eslint";
 import { linesBeforeHasStory, parentChainHasStory, fallbackTextBeforeHasStory } from "./require-story-io";
 import { getNodeName } from "./require-story-utils";
-import { DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES } from "./require-story-core";
+import { DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES, STORY_PATH } from "./require-story-core";
 /**
- * Path to the story file for annotations
- */
-declare const STORY_PATH = "docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md";
-/**
- * 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;
-/**
- * Number of physical source lines to inspect before a node when searching for @story text
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED - Replace magic number for lookback lines with named constant
- */
-declare const LOOKBACK_LINES = 4;
-/**
- * Window (in characters) to inspect before a node as a fallback when searching for @story text
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED - Replace magic number for fallback text window with named constant
- */
-declare const FALLBACK_WINDOW = 800;
 /**
  * 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;
 /**
@@ -77,85 +49,34 @@ 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;
-}
-/**
- * Report a missing @story annotation for a function-like node
- * Provides a suggestion to add the annotation.
- * @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
- * @req REQ-ANNOTATION-REQUIRED - Implement reporting for missing annotations with suggestion
- * @req REQ-AUTOFIX-MISSING - Provide autofix for missing annotations while preserving suggestions
- * @req REQ-ERROR-SPECIFIC - Error reports must include both name and functionName in the data payload for specific function context
- * @param {Rule.RuleContext} context - ESLint rule context used to report
- * @param {any} sourceCode - ESLint sourceCode object
- * @param {{ node: any; target?: any; options?: ReportOptions }} config - configuration containing the node to report, optional insertion target, and optional report options
- */
 declare function reportMissing(context: Rule.RuleContext, sourceCode: any, config: {
     node: any;
     target?: any;
     options?: ReportOptions;
 }): void;
-/**
- * Report a missing @story annotation for a method-like node
- * Provides a suggestion to update the method/interface with the annotation.
- * The error data payload uses both name and functionName for consistent, specific error context.
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @story docs/stories/008.0-DEV-AUTO-FIX.story.md
- * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
- * @req REQ-ANNOTATION-REQUIRED - Implement reporting for missing method/interface annotations with suggestion
- * @req REQ-AUTOFIX-MISSING - Provide autofix for missing method/interface annotations while preserving suggestions
- * @req REQ-ERROR-SPECIFIC - Method error reports must include both name and functionName in the data payload for specific function context
- * @req REQ-ERROR-LOCATION - Method error reports must use the method name node to anchor error location
- * @req REQ-ERROR-CONTEXT - Method error reports must include functionName data for consistent error context
- * @param {Rule.RuleContext} context - ESLint rule context to report
- * @param {any} sourceCode - ESLint sourceCode object
- * @param {{ node: any; target?: any; options?: ReportOptions }} config - configuration containing the node to report, optional insertion target, and optional report options
- */
 declare function reportMethod(context: Rule.RuleContext, sourceCode: any, config: {
     node: any;
     target?: any;
     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, LOOKBACK_LINES, FALLBACK_WINDOW, isExportedNode, jsdocHasStory, commentsBeforeHasStory, leadingCommentsHasStory, hasStoryAnnotation, getNodeName, extractName, resolveTargetNode, shouldProcessNode, reportMissing, reportMethod, DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES, linesBeforeHasStory, parentChainHasStory, fallbackTextBeforeHasStory, };
+export { STORY_PATH, getAnnotationTemplate, shouldApplyAutoFix, isExportedNode, jsdocHasStory, commentsBeforeHasStory, leadingCommentsHasStory, hasStoryAnnotation, getNodeName, extractName, resolveTargetNode, shouldProcessNode, DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES, linesBeforeHasStory, parentChainHasStory, fallbackTextBeforeHasStory, reportMissing, reportMethod, };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fallbackTextBeforeHasStory = exports.parentChainHasStory = exports.linesBeforeHasStory = exports.EXPORT_PRIORITY_VALUES = exports.DEFAULT_SCOPE = exports.getNodeName = exports.FALLBACK_WINDOW = exports.LOOKBACK_LINES = exports.STORY_PATH = void 0;
+exports.fallbackTextBeforeHasStory = exports.parentChainHasStory = exports.linesBeforeHasStory = exports.EXPORT_PRIORITY_VALUES = exports.DEFAULT_SCOPE = exports.getNodeName = exports.STORY_PATH = void 0;
 exports.getAnnotationTemplate = getAnnotationTemplate;
 exports.shouldApplyAutoFix = shouldApplyAutoFix;
 exports.isExportedNode = isExportedNode;
@@ -22,26 +22,13 @@ Object.defineProperty(exports, "getNodeName", { enumerable: true, get: function
 const require_story_core_1 = require("./require-story-core");
 Object.defineProperty(exports, "DEFAULT_SCOPE", { enumerable: true, get: function () { return require_story_core_1.DEFAULT_SCOPE; } });
 Object.defineProperty(exports, "EXPORT_PRIORITY_VALUES", { enumerable: true, get: function () { return require_story_core_1.EXPORT_PRIORITY_VALUES; } });
-/**
- * Path to the story file for annotations
- */
-const STORY_PATH = "docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md";
-exports.STORY_PATH = STORY_PATH;
-/**
- * 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.
- */
+Object.defineProperty(exports, "STORY_PATH", { enumerable: true, get: function () { return require_story_core_1.STORY_PATH; } });
 function getAnnotationTemplate(override) {
     if (typeof override === "string" && override.trim().length > 0) {
         return override.trim();
     }
-    return `/** @story ${STORY_PATH} */`;
+    return `/** @story ${require_story_core_1.STORY_PATH} */`;
 }
-/**
- * Determine whether auto-fix should be applied.
- * Explicit false disables auto-fix; all other values enable it.
- */
 function shouldApplyAutoFix(autoFix) {
     if (autoFix === false) {
         return false;
@@ -49,30 +36,21 @@ function shouldApplyAutoFix(autoFix) {
     return true;
 }
 /**
- * Number of physical source lines to inspect before a node when searching for @story text
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED - Replace magic number for lookback lines with named constant
- */
-const LOOKBACK_LINES = 4;
-exports.LOOKBACK_LINES = LOOKBACK_LINES;
-/**
- * Window (in characters) to inspect before a node as a fallback when searching for @story text
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED - Replace magic number for fallback text window with named constant
+ * Build the effective annotation template and autofix toggle
+ * from the provided report options.
  */
-const FALLBACK_WINDOW = 800;
-exports.FALLBACK_WINDOW = FALLBACK_WINDOW;
+function buildTemplateConfig(options) {
+    const effectiveTemplate = getAnnotationTemplate(options?.annotationTemplateOverride);
+    const allowFix = shouldApplyAutoFix(options?.autoFixToggle);
+    return { effectiveTemplate, allowFix };
+}
 /**
  * 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
  */
 function isExportedNode(node) {
     let p = node.parent;
-    // @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-    // @req REQ-ANNOTATION-REQUIRED - Walk parent chain to find Export declarations
     while (p) {
         if (p.type === "ExportNamedDeclaration" ||
             p.type === "ExportDefaultDeclaration") {
@@ -86,9 +64,6 @@ function isExportedNode(node) {
  * 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
  */
 function jsdocHasStory(sourceCode, node) {
     if (typeof sourceCode?.getJSDocComment !== "function") {
@@ -103,9 +78,6 @@ function jsdocHasStory(sourceCode, node) {
  * 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
  */
 function commentsBeforeHasStory(sourceCode, node) {
     if (typeof sourceCode?.getCommentsBefore !== "function") {
@@ -119,8 +91,6 @@ function commentsBeforeHasStory(sourceCode, node) {
  * 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
  */
 function leadingCommentsHasStory(node) {
     const leadingComments = (node && node.leadingComments) || [];
@@ -132,9 +102,6 @@ function leadingCommentsHasStory(node) {
  * 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
  */
 function hasStoryAnnotation(sourceCode, node) {
     try {
@@ -147,7 +114,7 @@ function hasStoryAnnotation(sourceCode, node) {
         if (leadingCommentsHasStory(node)) {
             return true;
         }
-        if ((0, require_story_io_1.linesBeforeHasStory)(sourceCode, node, LOOKBACK_LINES)) {
+        if ((0, require_story_io_1.linesBeforeHasStory)(sourceCode, node)) {
             return true;
         }
         if ((0, require_story_io_1.parentChainHasStory)(sourceCode, node)) {
@@ -157,8 +124,10 @@ function hasStoryAnnotation(sourceCode, node) {
             return true;
         }
     }
-    catch {
-        /* noop */
+    catch (error) {
+        if (process.env.TRACEABILITY_DEBUG === "1") {
+            console.error("[traceability] hasStoryAnnotation failed for node", error?.message ?? error);
+        }
     }
     return false;
 }
@@ -166,9 +135,6 @@ function hasStoryAnnotation(sourceCode, node) {
  * 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
  */
 function resolveTargetNode(sourceCode, node) {
     if (node.type === "TSMethodSignature") {
@@ -194,54 +160,72 @@ function resolveTargetNode(sourceCode, node) {
     }
     return node;
 }
+/**
+ * Extract a direct Identifier name when available on the given node.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Extract direct Identifier-based names from nodes
+ */
+function getDirectIdentifierName(node) {
+    if (node &&
+        node.type === "Identifier" &&
+        typeof node.name === "string" &&
+        node.name.length > 0) {
+        return node.name;
+    }
+    return null;
+}
+/**
+ * Normalize container nodes that expose names via id/key properties.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Normalize container id/key-based names into a single helper
+ */
+function getContainerKeyOrIdName(node) {
+    if (!node) {
+        return null;
+    }
+    if (node.id) {
+        const idName = (0, require_story_utils_1.getNodeName)(node.id);
+        if (typeof idName === "string" && idName.length > 0) {
+            return idName;
+        }
+    }
+    if (node.key) {
+        const keyName = (0, require_story_utils_1.getNodeName)(node.key);
+        if (typeof keyName === "string" && keyName.length > 0) {
+            return keyName;
+        }
+        if (node.key.type === "Literal" &&
+            typeof node.key.value === "string" &&
+            node.key.value.length > 0) {
+            return node.key.value;
+        }
+    }
+    return null;
+}
 /**
  * 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
  */
 function extractName(node) {
-    let n = node;
-    while (n) {
-        // Direct Identifier node
-        if (n.type === "Identifier" && typeof n.name === "string") {
-            return n.name;
+    let current = node;
+    while (current) {
+        const directIdentifierName = getDirectIdentifierName(current);
+        if (directIdentifierName) {
+            return directIdentifierName;
         }
-        // id property (FunctionDeclaration, etc.)
-        if (n.id && n.id.type === "Identifier" && typeof n.id.name === "string") {
-            return n.id.name;
+        const containerName = getContainerKeyOrIdName(current);
+        if (containerName) {
+            return containerName;
         }
-        // key property (Property, MethodDefinition, etc.)
-        if (n.key &&
-            n.key.type === "Identifier" &&
-            typeof n.key.name === "string") {
-            return n.key.name;
+        const directName = current.name;
+        if (typeof directName === "string" && directName.length > 0) {
+            return directName;
         }
-        // name property (some nodes may have a 'name' string directly)
-        if (typeof n.name === "string" && n.name.length > 0) {
-            return n.name;
-        }
-        // computed keys may have an Identifier inside
-        if (n.key &&
-            n.key.type === "Literal" &&
-            typeof n.key.value === "string") {
-            return n.key.value;
-        }
-        n = n.parent;
+        current = current.parent;
     }
     return "(anonymous)";
 }
-/**
- * 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
- */
 function shouldProcessNode(node, scope, exportPriority = "all") {
     if (!scope.includes(node.type)) {
         return false;
@@ -256,94 +240,62 @@ function shouldProcessNode(node, scope, exportPriority = "all") {
     return true;
 }
 /**
- * Report a missing @story annotation for a function-like node
- * Provides a suggestion to add the annotation.
+ * Resolve the effective function name to report for a node.
  * @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
- * @req REQ-ANNOTATION-REQUIRED - Implement reporting for missing annotations with suggestion
- * @req REQ-AUTOFIX-MISSING - Provide autofix for missing annotations while preserving suggestions
- * @req REQ-ERROR-SPECIFIC - Error reports must include both name and functionName in the data payload for specific function context
- * @param {Rule.RuleContext} context - ESLint rule context used to report
- * @param {any} sourceCode - ESLint sourceCode object
- * @param {{ node: any; target?: any; options?: ReportOptions }} config - configuration containing the node to report, optional insertion target, and optional report options
+ * @req REQ-ANNOTATION-REQUIRED - Centralize reported function name resolution
  */
-function reportMissing(context, sourceCode, config) {
-    const { node, target: passedTarget, options = {} } = config;
-    try {
-        const functionName = extractName(node && (node.id || node.key) ? node.id || node.key : node);
-        if (hasStoryAnnotation(sourceCode, node)) {
-            return;
-        }
-        const resolvedTarget = passedTarget ?? resolveTargetNode(sourceCode, node);
-        const name = functionName;
-        const nameNode = (node.id && node.id.type === "Identifier" && node.id) ||
-            (node.key && node.key.type === "Identifier" && node.key) ||
-            node;
-        const effectiveTemplate = getAnnotationTemplate(options.annotationTemplateOverride);
-        const allowFix = shouldApplyAutoFix(options.autoFixToggle);
-        context.report({
-            node: nameNode,
-            messageId: "missingStory",
-            data: { name, functionName: name },
-            fix: allowFix
-                ? (0, require_story_core_1.createAddStoryFix)(resolvedTarget, effectiveTemplate)
-                : undefined,
-            suggest: [
-                {
-                    desc: `Add JSDoc @story annotation for function '${name}', e.g., ${effectiveTemplate}`,
-                    fix: (0, require_story_core_1.createAddStoryFix)(resolvedTarget, effectiveTemplate),
-                },
-            ],
-        });
+function getReportedFunctionName(node) {
+    const candidate = node && (node.id || node.key) ? node.id || node.key : node;
+    return extractName(candidate);
+}
+/**
+ * Determine the most appropriate AST node to anchor error location for a report.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Normalize name node selection for error reporting
+ */
+function getNameNodeForReport(node) {
+    if (node?.id?.type === "Identifier") {
+        return node.id;
     }
-    catch {
-        /* noop */
+    if (node?.key?.type === "Identifier") {
+        return node.key;
     }
+    return node;
 }
 /**
- * Report a missing @story annotation for a method-like node
- * Provides a suggestion to update the method/interface with the annotation.
- * The error data payload uses both name and functionName for consistent, specific error context.
+ * Resolve the node that should receive the @story annotation,
+ * respecting an explicitly passed target when provided.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @story docs/stories/008.0-DEV-AUTO-FIX.story.md
- * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
- * @req REQ-ANNOTATION-REQUIRED - Implement reporting for missing method/interface annotations with suggestion
- * @req REQ-AUTOFIX-MISSING - Provide autofix for missing method/interface annotations while preserving suggestions
- * @req REQ-ERROR-SPECIFIC - Method error reports must include both name and functionName in the data payload for specific function context
- * @req REQ-ERROR-LOCATION - Method error reports must use the method name node to anchor error location
- * @req REQ-ERROR-CONTEXT - Method error reports must include functionName data for consistent error context
- * @param {Rule.RuleContext} context - ESLint rule context to report
- * @param {any} sourceCode - ESLint sourceCode object
- * @param {{ node: any; target?: any; options?: ReportOptions }} config - configuration containing the node to report, optional insertion target, and optional report options
+ * @req REQ-ANNOTATION-REQUIRED - Centralize annotation target node resolution
  */
+function resolveAnnotationTargetNode(sourceCode, node, passedTarget) {
+    return passedTarget ?? resolveTargetNode(sourceCode, node);
+}
+function reportMissing(context, sourceCode, config) {
+    (0, require_story_core_1.coreReportMissing)({
+        hasStoryAnnotation,
+        getReportedFunctionName,
+        resolveAnnotationTargetNode,
+        getNameNodeForReport,
+        buildTemplateConfig,
+        extractName,
+        getAnnotationTemplate,
+        shouldApplyAutoFix,
+        createAddStoryFix: require_story_core_1.createAddStoryFix,
+        createMethodFix: require_story_core_1.createMethodFix,
+    }, context, sourceCode, config);
+}
 function reportMethod(context, sourceCode, config) {
-    const { node, target: passedTarget, options = {} } = config;
-    try {
-        if (hasStoryAnnotation(sourceCode, node)) {
-            return;
-        }
-        const resolvedTarget = passedTarget ?? resolveTargetNode(sourceCode, node);
-        const name = extractName(node);
-        const nameNode = (node.key && node.key.type === "Identifier" && node.key) || node;
-        const effectiveTemplate = getAnnotationTemplate(options.annotationTemplateOverride);
-        const allowFix = shouldApplyAutoFix(options.autoFixToggle);
-        context.report({
-            node: nameNode,
-            messageId: "missingStory",
-            data: { name, functionName: name },
-            fix: allowFix
-                ? (0, require_story_core_1.createMethodFix)(resolvedTarget, effectiveTemplate)
-                : undefined,
-            suggest: [
-                {
-                    desc: `Add JSDoc @story annotation for function '${name}', e.g., ${effectiveTemplate}`,
-                    fix: (0, require_story_core_1.createMethodFix)(resolvedTarget, effectiveTemplate),
-                },
-            ],
-        });
-    }
-    catch {
-        /* noop */
-    }
+    (0, require_story_core_1.coreReportMethod)({
+        hasStoryAnnotation,
+        getReportedFunctionName,
+        resolveAnnotationTargetNode,
+        getNameNodeForReport,
+        buildTemplateConfig,
+        extractName,
+        getAnnotationTemplate,
+        shouldApplyAutoFix,
+        createAddStoryFix: require_story_core_1.createAddStoryFix,
+        createMethodFix: require_story_core_1.createMethodFix,
+    }, context, sourceCode, config);
 }

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

@@ -133,42 +133,32 @@ function parentChainHasStory(sourceCode, node) {
     return false;
 }
 /**
- * Fallback: inspect text immediately preceding the node in sourceCode.getText to find @story
- * Also accepts @supports annotations as satisfying story presence for this rule.
+ * Safely compute the starting range index for fallback text scanning.
+ * Centralizes guards around sourceCode.getText and node.range structure.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @story docs/stories/010.2-DEV-MULTI-STORY-SUPPORT.story.md
- * @req REQ-ANNOTATION-REQUIRED - Provide fallback textual inspection when other heuristics fail
- * @req REQ-REQUIRE-ACCEPTS-IMPLEMENTS - Treat @supports annotations as satisfying story presence in fallback checks
+ * @req REQ-ANNOTATION-REQUIRED - Centralize guards for fallback range computation
  */
-function fallbackTextBeforeHasStory(sourceCode, node) {
-    // Skip fallback text inspection when the sourceCode API or node range information is not available.
-    // @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-    // @req REQ-ANNOTATION-REQUIRED - Avoid throwing when source text or range metadata cannot be read
-    if (typeof sourceCode?.getText !== "function" ||
-        !Array.isArray((node && node.range) || [])) {
-        return false;
+function getFallbackRangeStart(sourceCode, node) {
+    if (typeof sourceCode?.getText !== "function") {
+        return null;
     }
-    const range = node.range;
-    // Guard against malformed range values that cannot provide a numeric start index for slicing.
-    // @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-    // @req REQ-ANNOTATION-REQUIRED - Validate node range structure before computing fallback window
+    const range = (node && node.range) || null;
     if (!Array.isArray(range) || typeof range[0] !== "number") {
-        return false;
+        return null;
     }
+    return range[0];
+}
+/**
+ * Safely slice a bounded fallback text window immediately preceding the node start index.
+ * Restricts scanning to a fixed-size window and treats IO/slicing failures as non-fatal.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Restrict fallback text scanning to a safe, fixed-size window and handle failures gracefully
+ */
+function getFallbackTextWindow(sourceCode, nodeStartIndex) {
+    const start = Math.max(0, nodeStartIndex - exports.FALLBACK_WINDOW);
     try {
-        // Limit the fallback inspection window to a bounded region immediately preceding the node.
-        // @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-        // @req REQ-ANNOTATION-REQUIRED - Restrict fallback text scanning to a safe, fixed-size window
-        const start = Math.max(0, range[0] - exports.FALLBACK_WINDOW);
-        const textBefore = sourceCode.getText().slice(start, range[0]);
-        // Detect any @story or @supports marker that appears within the bounded fallback window.
-        // @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-        // @req REQ-ANNOTATION-REQUIRED - Recognize story annotations discovered via fallback text scanning
-        // @req REQ-REQUIRE-ACCEPTS-IMPLEMENTS - Recognize @supports annotations discovered via fallback text scanning
-        if (typeof textBefore === "string" &&
-            (textBefore.includes("@story") || textBefore.includes("@supports"))) {
-            return true;
-        }
+        const textBefore = sourceCode.getText().slice(start, nodeStartIndex);
+        return typeof textBefore === "string" ? textBefore : null;
     }
     catch {
         /*
@@ -176,6 +166,36 @@ function fallbackTextBeforeHasStory(sourceCode, node) {
          * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
          * @req REQ-ANNOTATION-REQUIRED - Treat fallback text inspection failures as "no annotation" instead of raising
          */
+        return null;
     }
-    return false;
+}
+/**
+ * Detect whether the provided fallback text window contains a story marker.
+ * Recognizes both @story and @supports annotations in the inspected text.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @story docs/stories/010.2-DEV-MULTI-STORY-SUPPORT.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Recognize story annotations discovered via fallback text scanning
+ * @req REQ-REQUIRE-ACCEPTS-IMPLEMENTS - Recognize @supports annotations discovered via fallback text scanning
+ */
+function fallbackTextHasMarker(textBefore) {
+    if (typeof textBefore !== "string") {
+        return false;
+    }
+    return textBefore.includes("@story") || textBefore.includes("@supports");
+}
+/**
+ * Fallback: inspect text immediately preceding the node in sourceCode.getText to find @story
+ * Also accepts @supports annotations as satisfying story presence for this rule.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @story docs/stories/010.2-DEV-MULTI-STORY-SUPPORT.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Provide fallback textual inspection when other heuristics fail
+ * @req REQ-REQUIRE-ACCEPTS-IMPLEMENTS - Treat @supports annotations as satisfying story presence in fallback checks
+ */
+function fallbackTextBeforeHasStory(sourceCode, node) {
+    const nodeStartIndex = getFallbackRangeStart(sourceCode, node);
+    if (nodeStartIndex === null) {
+        return false;
+    }
+    const textBefore = getFallbackTextWindow(sourceCode, nodeStartIndex);
+    return fallbackTextHasMarker(textBefore);
 }