eslint-plugin-traceability 1.21.1 → 1.22.0

package/lib/src/rules/helpers/prefer-implements-inline.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processInlineComments = processInlineComments;
+const valid_annotation_format_internal_1 = require("../helpers/valid-annotation-format-internal");
+const MIN_STORY_TOKENS = 2;
+const MIN_REQ_TOKENS = 2;
+/**
+ * Extract the leading whitespace and `//` prefix from a line comment's full
+ * source text so that new inline annotations can be inserted with matching
+ * indentation and formatting.
+ *
+ * @story docs/stories/010.3-DEV-MIGRATE-TO-SUPPORTS.story.md
+ * @req REQ-MIGRATE-INLINE
+ */
+function getLinePrefixFromText(fullText) {
+    const match = fullText.match(/^(\s*\/\/\s*)/);
+    return match ? match[1] : "";
+}
+/**
+ * Attempt to construct an inline auto-fix that replaces a contiguous
+ * sequence of `@story` and `@req` line comments with a single `@supports`
+ * annotation while preserving the original comment prefix.
+ *
+ * @story docs/stories/010.3-DEV-MIGRATE-TO-SUPPORTS.story.md
+ * @req REQ-MIGRATE-INLINE
+ */
+function tryBuildInlineAutoFix(context, comments, storyIndex, reqIndices) {
+    const sourceCode = context.getSourceCode();
+    const storyComment = comments[storyIndex];
+    const storyNormalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(storyComment.value || "");
+    if (!storyNormalized || !/^@story\b/.test(storyNormalized)) {
+        return null;
+    }
+    const storyParts = storyNormalized.split(/\s+/);
+    if (storyParts.length !== MIN_STORY_TOKENS) {
+        return null;
+    }
+    const storyPath = storyParts[1];
+    const reqIds = [];
+    for (const idx of reqIndices) {
+        const reqComment = comments[idx];
+        const reqNormalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(reqComment.value || "");
+        if (!reqNormalized || !/^@req\b/.test(reqNormalized)) {
+            return null;
+        }
+        const reqParts = reqNormalized.split(/\s+/);
+        if (reqParts.length !== MIN_REQ_TOKENS) {
+            return null;
+        }
+        reqIds.push(reqParts[1]);
+    }
+    if (!reqIds.length) {
+        return null;
+    }
+    const fullText = sourceCode.text.slice(storyComment.range[0], storyComment.range[1]);
+    const linePrefix = getLinePrefixFromText(fullText);
+    const implAnnotation = `@supports ${storyPath} ${reqIds.join(" ")}`;
+    const implLine = `${linePrefix}${implAnnotation}`;
+    const start = storyComment.range[0];
+    const end = comments[reqIndices[reqIndices.length - 1]].range[1];
+    return (fixer) => fixer.replaceTextRange([start, end], implLine);
+}
+/**
+ * Coordinate detection and optional migration of a single inline `@story`
+ * comment and its following `@req` comments, reporting diagnostics and
+ * scheduling auto-fixes where safe.
+ *
+ * @story docs/stories/010.3-DEV-MIGRATE-TO-SUPPORTS.story.md
+ * @req REQ-MIGRATE-INLINE
+ */
+function collectReqIndicesAfterStory(group, startIndex) {
+    const n = group.length;
+    const reqIndices = [];
+    let j = startIndex + 1;
+    while (j < n) {
+        const next = group[j];
+        const nextNormalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(next.value || "");
+        if (!nextNormalized || /^@supports\b/.test(nextNormalized)) {
+            break;
+        }
+        if (/^@req\b/.test(nextNormalized)) {
+            reqIndices.push(j);
+            j += 1;
+            continue;
+        }
+        break;
+    }
+    return { reqIndices, nextIndex: j };
+}
+function handleInlineStorySequence(context, group, startIndex) {
+    const current = group[startIndex];
+    const normalized = (0, valid_annotation_format_internal_1.normalizeCommentLine)(current.value || "");
+    if (!normalized || !/^@story\b/.test(normalized)) {
+        return startIndex + 1;
+    }
+    const { reqIndices, nextIndex } = collectReqIndicesAfterStory(group, startIndex);
+    if (reqIndices.length === 0) {
+        return startIndex + 1;
+    }
+    const fix = tryBuildInlineAutoFix(context, group, startIndex, reqIndices);
+    context.report({
+        node: current,
+        messageId: "preferImplements",
+        fix: fix || undefined,
+    });
+    return nextIndex;
+}
+function advanceInlineGroupIndex(context, group, i) {
+    if (i >= group.length) {
+        return i;
+    }
+    return handleInlineStorySequence(context, group, i);
+}
+function processInlineGroup(context, group) {
+    let i = 0;
+    while (i < group.length) {
+        i = advanceInlineGroupIndex(context, group, i);
+    }
+}
+/**
+ * Scan sequences of Line comments for inline legacy story and requirement patterns
+ * and report diagnostics with optional auto-fixes.
+ */
+function processInlineComments(context, lineComments) {
+    if (!lineComments.length)
+        return;
+    // Group by contiguous line numbers
+    let group = [lineComments[0]];
+    const flushGroup = () => {
+        processInlineGroup(context, group);
+        group = [];
+    };
+    for (let idx = 1; idx < lineComments.length; idx++) {
+        const prev = lineComments[idx - 1];
+        const curr = lineComments[idx];
+        if (curr.loc.start.line === prev.loc.start.line + 1 &&
+            curr.loc.start.column === prev.loc.start.column) {
+            group.push(curr);
+        }
+        else {
+            flushGroup();
+            group.push(curr);
+        }
+    }
+    flushGroup();
+}

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

@@ -0,0 +1,47 @@
+/**
+ * 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
+ */
+export 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
+ */
+export 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
+ */
+export declare function leadingCommentsHasStory(node: any): boolean;
+/**
+ * Check if `@story` annotation already present in JSDoc or preceding comments.
+ * 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
+ */
+export declare function hasStoryAnnotation(sourceCode: any, node: any): boolean;
+/**
+ * Placement-aware story detection helper used by core reporting.
+ *
+ * When annotationPlacement is "inside" and the node supports inside-brace
+ * semantics, this helper only treats annotations found on the first
+ * comment-only lines inside the function or method body as satisfying the
+ * requirement. JSDoc and before-function comments are intentionally ignored so
+ * that misplaced annotations are reported as violations under the inside
+ * standard.
+ *
+ * For nodes that do not support inside placement (such as TS declarations,
+ * signature-only nodes, or functions without block bodies), this helper
+ * delegates to the existing hasStoryAnnotation heuristics so that they
+ * continue to rely on before-function placement.
+ *
+ * @supports docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md REQ-ALL-BLOCK-TYPES REQ-INSIDE-BRACE-PLACEMENT REQ-PLACEMENT-CONFIG
+ */
+export declare function hasStoryAnnotationWithPlacement(sourceCode: any, node: any, annotationPlacement: "before" | "inside"): boolean;

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

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsdocHasStory = jsdocHasStory;
+exports.commentsBeforeHasStory = commentsBeforeHasStory;
+exports.leadingCommentsHasStory = leadingCommentsHasStory;
+exports.hasStoryAnnotation = hasStoryAnnotation;
+exports.hasStoryAnnotationWithPlacement = hasStoryAnnotationWithPlacement;
+/**
+ * Comment detection utilities for require-story rule
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - File-level header for comment detection utilities
+ */
+const require_story_io_1 = require("./require-story-io");
+const function_annotation_helpers_1 = require("../../utils/function-annotation-helpers");
+const require_story_node_utils_1 = require("./require-story-node-utils");
+/**
+ * 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
+ */
+function jsdocHasStory(sourceCode, node) {
+    if (typeof sourceCode?.getJSDocComment !== "function") {
+        return false;
+    }
+    const jsdoc = sourceCode.getJSDocComment(node);
+    return !!(jsdoc &&
+        typeof jsdoc.value === "string" &&
+        jsdoc.value.includes("@story"));
+}
+/**
+ * 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
+ */
+function commentsBeforeHasStory(sourceCode, node) {
+    if (typeof sourceCode?.getCommentsBefore !== "function") {
+        return false;
+    }
+    const commentsBefore = sourceCode.getCommentsBefore(node) || [];
+    return (Array.isArray(commentsBefore) &&
+        commentsBefore.some((c) => typeof c.value === "string" && c.value.includes("@story")));
+}
+/**
+ * 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
+ */
+function leadingCommentsHasStory(node) {
+    const leadingComments = (node && node.leadingComments) || [];
+    return (Array.isArray(leadingComments) &&
+        leadingComments.some((c) => typeof c.value === "string" && c.value.includes("@story")));
+}
+/**
+ * Check if `@story` annotation already present in JSDoc or preceding comments.
+ * 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
+ */
+function hasStoryAnnotation(sourceCode, node) {
+    try {
+        // Direct, node-local checks always apply first.
+        if (jsdocHasStory(sourceCode, node)) {
+            return true;
+        }
+        if (commentsBeforeHasStory(sourceCode, node)) {
+            return true;
+        }
+        if (leadingCommentsHasStory(node)) {
+            return true;
+        }
+        if (!(0, require_story_node_utils_1.isNestedFunction)(node) && (0, require_story_io_1.linesBeforeHasStory)(sourceCode, node)) {
+            return true;
+        }
+        const canInherit = (0, require_story_node_utils_1.isNestedFunction)(node) && (0, require_story_node_utils_1.isEffectivelyAnonymousFunction)(node);
+        // Only nodes that are allowed to inherit annotations (e.g., nested anonymous
+        // callbacks) may treat parent-chain comments or broad fallback text as
+        // satisfying the annotation requirement.
+        if (canInherit && (0, require_story_io_1.parentChainHasStory)(sourceCode, node)) {
+            return true;
+        }
+        if (canInherit && (0, require_story_io_1.fallbackTextBeforeHasStory)(sourceCode, node)) {
+            return true;
+        }
+        if (canInherit) {
+            return true;
+        }
+    }
+    catch (error) {
+        if (process.env.TRACEABILITY_DEBUG === "1") {
+            console.error("[traceability] hasStoryAnnotation failed for node", error?.message ?? error);
+        }
+    }
+    return false;
+}
+/**
+ * Placement-aware story detection helper used by core reporting.
+ *
+ * When annotationPlacement is "inside" and the node supports inside-brace
+ * semantics, this helper only treats annotations found on the first
+ * comment-only lines inside the function or method body as satisfying the
+ * requirement. JSDoc and before-function comments are intentionally ignored so
+ * that misplaced annotations are reported as violations under the inside
+ * standard.
+ *
+ * For nodes that do not support inside placement (such as TS declarations,
+ * signature-only nodes, or functions without block bodies), this helper
+ * delegates to the existing hasStoryAnnotation heuristics so that they
+ * continue to rely on before-function placement.
+ *
+ * @supports docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md REQ-ALL-BLOCK-TYPES REQ-INSIDE-BRACE-PLACEMENT REQ-PLACEMENT-CONFIG
+ */
+function hasStoryAnnotationWithPlacement(sourceCode, node, annotationPlacement) {
+    // Backward-compatible default: use existing heuristics when placement is
+    // "before" or when the function does not support inside-brace semantics.
+    if (annotationPlacement !== "inside" ||
+        !(0, function_annotation_helpers_1.supportsInsidePlacementForFunction)(node)) {
+        return hasStoryAnnotation(sourceCode, node);
+    }
+    try {
+        const insideText = (0, function_annotation_helpers_1.getFunctionInsideBodyCommentText)(sourceCode, node);
+        if (typeof insideText === "string" &&
+            (insideText.includes("@story") || insideText.includes("@supports"))) {
+            return true;
+        }
+    }
+    catch (error) {
+        if (process.env.TRACEABILITY_DEBUG === "1") {
+            // Debug logging only when explicitly enabled for troubleshooting helper failures.
+            console.error("[traceability] hasStoryAnnotationWithPlacement failed for node", error?.message ?? error);
+        }
+    }
+    // In inside-placement mode for block-bodied functions and methods we
+    // intentionally do not fall back to before-function heuristics; callers
+    // should treat this as a missing annotation so that misplaced comments are
+    // reported as violations.
+    return false;
+}

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

@@ -1,21 +1,21 @@
 /**
- * Create a fixer function that inserts a @story annotation before the target node.
+ * 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
+ * @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
+ * 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.
+ * 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
@@ -57,7 +57,7 @@ type ReportDeps = {
     hasStoryAnnotationWithPlacement?: (_sourceCode: any, _node: any, _placement: "before" | "inside") => boolean;
 };
 /**
- * Core helper to report a missing @story annotation for a function-like node.
+ * Core helper to report a missing `@story` annotation for a function-like node.
  * 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
@@ -73,7 +73,7 @@ export declare function coreReportMissing(deps: ReportDeps, context: Rule.RuleCo
     options?: CoreReportOptions;
 }): void;
 /**
- * Core helper to report a missing @story annotation for a method-like node.
+ * Core helper to report a missing `@story` annotation for a method-like node.
  * 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

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

@@ -5,7 +5,6 @@ exports.createAddStoryFix = createAddStoryFix;
 exports.createMethodFix = createMethodFix;
 exports.coreReportMissing = coreReportMissing;
 exports.coreReportMethod = coreReportMethod;
-/* eslint-disable traceability/valid-annotation-format */
 /**
  * Compute the insertion start offset for inserting annotations before a node.
  * This helper ensures we insert before any export wrapper when present, while
@@ -33,18 +32,18 @@ function getInsertionStart(candidate) {
     return 0;
 }
 /**
- * Create a fixer function that inserts a @story annotation before the target node.
+ * 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
+ * @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.
+     * 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
+     * @req REQ-AUTOFIX - Provide automatic fix function for missing `@story` annotations
      */
     function addStoryFixer(fixer) {
         const start = getInsertionStart(target);
@@ -54,14 +53,14 @@ function createAddStoryFix(target, annotationTemplate) {
 }
 /**
  * Create a fixer function for class method annotations.
- * This helper ensures that the @story annotation is inserted with appropriate
+ * 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.
+     * 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
@@ -74,7 +73,7 @@ function createMethodFix(node, annotationTemplate) {
     return methodFixer;
 }
 /**
- * Default set of node types to check for missing @story annotations.
+ * 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
@@ -118,7 +117,7 @@ function withSafeReporting(label, fn) {
     }
 }
 /**
- * Build the shared ESLint report descriptor for a missing @story annotation.
+ * Build the shared ESLint report descriptor for a missing story annotation.
  * This keeps the core helpers focused on computing names, targets, and
  * templates while centralizing the diagnostic wiring.
  * @supports docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ERROR-SPECIFIC
@@ -145,7 +144,7 @@ function resolveAnnotationPlacement(options) {
     return raw === "inside" || raw === "before" ? raw : "before";
 }
 /**
- * Core helper to report a missing @story annotation for a function-like node.
+ * Core helper to report a missing `@story` annotation for a function-like node.
  * 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
@@ -184,7 +183,7 @@ function coreReportMissing(deps, context, sourceCode, config) {
     });
 }
 /**
- * Core helper to report a missing @story annotation for a method-like node.
+ * Core helper to report a missing `@story` annotation for a method-like node.
  * 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

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

@@ -9,9 +9,11 @@
  */
 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, STORY_PATH } from "./require-story-core";
 import { type CallbackExclusionOptions } from "./test-callback-exclusion";
+import { extractName } from "./require-story-name-extraction";
+import { isExportedNode, resolveTargetNode } from "./require-story-node-utils";
+import { jsdocHasStory, commentsBeforeHasStory, leadingCommentsHasStory, hasStoryAnnotation, hasStoryAnnotationWithPlacement } from "./require-story-comment-detection";
 /**
  * Shared configuration helpers
  */
@@ -23,67 +25,6 @@ interface ReportOptions extends CallbackExclusionOptions {
 /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */
 declare function getAnnotationTemplate(override?: string, _options?: CallbackExclusionOptions): string;
 declare function shouldApplyAutoFix(autoFix: boolean | undefined, _options?: CallbackExclusionOptions): 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
- */
-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
- */
-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
- */
-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
- */
-declare function leadingCommentsHasStory(node: any): boolean;
-/**
- * Check if @story annotation already present in JSDoc or preceding comments
- * 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
- */
-declare function hasStoryAnnotation(sourceCode: any, node: any): boolean;
-/**
- * Placement-aware story detection helper used by core reporting.
- *
- * When annotationPlacement is "inside" and the node supports inside-brace
- * semantics, this helper only treats annotations found on the first
- * comment-only lines inside the function or method body as satisfying the
- * requirement. JSDoc and before-function comments are intentionally ignored so
- * that misplaced annotations are reported as violations under the inside
- * standard.
- *
- * For nodes that do not support inside placement (such as TS declarations,
- * signature-only nodes, or functions without block bodies), this helper
- * delegates to the existing hasStoryAnnotation heuristics so that they
- * continue to rely on before-function placement.
- *
- * @supports docs/stories/028.0-DEV-ANNOTATION-PLACEMENT-STANDARDIZATION.story.md REQ-ALL-BLOCK-TYPES REQ-INSIDE-BRACE-PLACEMENT REQ-PLACEMENT-CONFIG
- */
-declare function hasStoryAnnotationWithPlacement(sourceCode: any, node: any, annotationPlacement: "before" | "inside"): 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
- */
-declare function resolveTargetNode(sourceCode: any, node: any): any;
-/**
- * Small utility to walk the node and its parents to extract an Identifier or key name.
- * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
- * @req REQ-ANNOTATION-REQUIRED - Walk node and parents to find Identifier/Key name
- */
-declare function extractName(node: any): string;
 /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */
 declare function shouldProcessNode(node: any, scope: string[], exportPriority?: string, options?: CallbackExclusionOptions): boolean;
 /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */
@@ -100,7 +41,8 @@ declare function reportMethod(context: Rule.RuleContext, sourceCode: any, config
 }): void;
 /**
  * Explicit exports for require-story-annotation helpers.
+ *
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-ANNOTATION-REQUIRED
  */
-export { STORY_PATH, getAnnotationTemplate, shouldApplyAutoFix, isExportedNode, jsdocHasStory, commentsBeforeHasStory, leadingCommentsHasStory, hasStoryAnnotation, hasStoryAnnotationWithPlacement, getNodeName, extractName, resolveTargetNode, shouldProcessNode, DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES, linesBeforeHasStory, parentChainHasStory, fallbackTextBeforeHasStory, reportMissing, reportMethod, };
+export { STORY_PATH, getAnnotationTemplate, shouldApplyAutoFix, isExportedNode, jsdocHasStory, commentsBeforeHasStory, leadingCommentsHasStory, hasStoryAnnotation, hasStoryAnnotationWithPlacement, extractName, resolveTargetNode, shouldProcessNode, DEFAULT_SCOPE, EXPORT_PRIORITY_VALUES, linesBeforeHasStory, parentChainHasStory, fallbackTextBeforeHasStory, reportMissing, reportMethod, };