eslint-plugin-traceability 1.21.0 → 1.22.0

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

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAnonymousArrowFunction = isAnonymousArrowFunction;
+exports.isNestedFunction = isNestedFunction;
+exports.isEffectivelyAnonymousFunction = isEffectivelyAnonymousFunction;
+exports.isExportedNode = isExportedNode;
+exports.resolveTargetNode = resolveTargetNode;
+exports.resolveAnnotationTargetNode = resolveAnnotationTargetNode;
+/**
+ * Node classification utilities for require-story rule
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - File-level header for node utility functions
+ */
+const require_story_name_extraction_1 = require("./require-story-name-extraction");
+/**
+ * Determine whether a node represents an anonymous arrow function expression
+ * where the parent variable declarator has no explicit Identifier name.
+ *
+ * @supports docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md REQ-ARROW-FUNCTION-EXCLUDED
+ */
+function isAnonymousArrowFunction(node) {
+    return !!node && node.type === "ArrowFunctionExpression";
+}
+/**
+ * Determine whether a function-like node is nested within another function.
+ *
+ * @supports docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md REQ-NESTED-FUNCTION-INHERITANCE
+ */
+function isNestedFunction(node) {
+    let current = node?.parent;
+    while (current) {
+        if (current.type === "FunctionDeclaration" ||
+            current.type === "FunctionExpression" ||
+            current.type === "ArrowFunctionExpression" ||
+            current.type === "MethodDefinition" ||
+            current.type === "TSDeclareFunction" ||
+            current.type === "TSMethodSignature") {
+            return true;
+        }
+        current = current.parent;
+    }
+    return false;
+}
+/**
+ * Determine whether a function-like node is effectively anonymous for the
+ * purposes of nested-function inheritance. Named functions must always carry
+ * their own annotations, while anonymous nested functions may inherit.
+ *
+ * @supports docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md REQ-NESTED-FUNCTION-INHERITANCE
+ */
+function isEffectivelyAnonymousFunction(node) {
+    const name = (0, require_story_name_extraction_1.getContainerKeyOrIdName)(node) ?? (0, require_story_name_extraction_1.getDirectIdentifierName)(node);
+    if (typeof name === "string" && name.length > 0 && name !== "(anonymous)") {
+        return false;
+    }
+    return true;
+}
+/**
+ * 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
+ */
+function isExportedNode(node) {
+    let p = node.parent;
+    while (p) {
+        if (p.type === "ExportNamedDeclaration" ||
+            p.type === "ExportDefaultDeclaration") {
+            return true;
+        }
+        p = p.parent;
+    }
+    return false;
+}
+/**
+ * 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
+ */
+function resolveTargetNode(sourceCode, node) {
+    if (node.type === "TSMethodSignature") {
+        // Interface method signature -> insert on interface
+        return node.parent.parent;
+    }
+    if (node.type === "FunctionExpression" ||
+        node.type === "ArrowFunctionExpression") {
+        const parent = node.parent;
+        if (parent.type === "VariableDeclarator") {
+            const varDecl = parent.parent;
+            if (varDecl.parent && varDecl.parent.type === "ExportNamedDeclaration") {
+                return varDecl.parent;
+            }
+            return varDecl;
+        }
+        if (parent.type === "ExportNamedDeclaration") {
+            return parent;
+        }
+        if (parent.type === "ExpressionStatement") {
+            return parent;
+        }
+    }
+    return node;
+}
+/**
+ * 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
+ * @req REQ-ANNOTATION-REQUIRED - Centralize annotation target node resolution
+ */
+function resolveAnnotationTargetNode(sourceCode, node, passedTarget) {
+    return passedTarget ?? resolveTargetNode(sourceCode, node);
+}

package/lib/src/rules/helpers/require-test-traceability-helpers.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.determineIsTestFile = determineIsTestFile;
 exports.ensureFileSupportsAnnotation = ensureFileSupportsAnnotation;
 exports.handleCallExpression = handleCallExpression;
+/* eslint-disable traceability/valid-annotation-format */
 /**
  * Helper utilities for the require-test-traceability rule.
  *

package/lib/src/rules/helpers/valid-annotation-format-internal.d.ts

@@ -19,7 +19,7 @@ export interface PendingAnnotation {
  * boundaries), keeps any annotation tags that appear later in the line, and
  * supports common JSDoc styles such as leading "*".
  *
- * It detects @story, @req, and @supports tags while preserving the rest
+ * It detects `@story`, `@req`, and `@supports` tags while preserving the rest
  * of the line for downstream logic.
  */
 export declare function normalizeCommentLine(rawLine: string): string;
@@ -27,7 +27,7 @@ export declare function normalizeCommentLine(rawLine: string): string;
  * Detect whether a normalized comment line starts with a non-traceability JSDoc tag.
  *
  * This is used to distinguish regular JSDoc tags (e.g. @param, @returns) from
- * traceability-related annotations such as @story, @req, and @supports.
+ * traceability-related annotations such as `@story`, `@req`, and `@supports`.
  *
  * Supports coexistence with JSDoc by:
  * - Detecting boundaries between traceability tags and other tags

package/lib/src/rules/helpers/valid-annotation-format-internal.js

@@ -15,7 +15,7 @@ exports.isNonTraceabilityJSDocTagLine = isNonTraceabilityJSDocTagLine;
  * boundaries), keeps any annotation tags that appear later in the line, and
  * supports common JSDoc styles such as leading "*".
  *
- * It detects @story, @req, and @supports tags while preserving the rest
+ * It detects `@story`, `@req`, and `@supports` tags while preserving the rest
  * of the line for downstream logic.
  */
 function normalizeCommentLine(rawLine) {
@@ -29,18 +29,26 @@ function normalizeCommentLine(rawLine) {
     // This ensures annotations that appear outside code spans are still
     // detected at their original indices.
     const filtered = trimmed.replace(/`[^`]*`/g, (match) => " ".repeat(match.length));
-    const annotationMatch = filtered.match(/@story\b|@req\b|@supports\b/);
+    // Remove leading star first to normalize JSDoc format
+    const withoutLeadingStar = filtered.replace(/^\*\s?/, "");
+    // Check if the line starts with a non-traceability JSDoc tag (e.g., @param, @returns)
+    // If so, return the whole line as-is to avoid false positives where annotation
+    // keywords appear in the tag's description (e.g., "`@returns` ... `@story` annotations")
+    if (/^@(?!story\b|req\b|supports\b)/.test(withoutLeadingStar)) {
+        return withoutLeadingStar;
+    }
+    // Otherwise, check for traceability annotations and slice to them if found
+    const annotationMatch = withoutLeadingStar.match(/@story\b|@req\b|@supports\b/);
     if (!annotationMatch || annotationMatch.index === undefined) {
-        const withoutLeadingStar = filtered.replace(/^\*\s?/, "");
         return withoutLeadingStar;
     }
-    return filtered.slice(annotationMatch.index);
+    return withoutLeadingStar.slice(annotationMatch.index);
 }
 /**
  * Detect whether a normalized comment line starts with a non-traceability JSDoc tag.
  *
  * This is used to distinguish regular JSDoc tags (e.g. @param, @returns) from
- * traceability-related annotations such as @story, @req, and @supports.
+ * traceability-related annotations such as `@story`, `@req`, and `@supports`.
  *
  * Supports coexistence with JSDoc by:
  * - Detecting boundaries between traceability tags and other tags

package/lib/src/rules/helpers/valid-annotation-format-validators.d.ts

@@ -7,9 +7,9 @@
  * to read while still preserving all existing behavior.
  *
  * The implementation in this module supports:
- * - validation of @story annotations
- * - validation of @req annotations
- * - validation of @implements/@supports-style annotations
+ * - validation of `@story` annotations
+ * - validation of `@req` annotations
+ * - validation of `@implements`/`@supports`-style annotations
  * - safe, minimal auto-fixes for certain invalid formats
  *
  * @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
@@ -33,9 +33,9 @@
 import type { ResolvedAnnotationOptions } from "./valid-annotation-options";
 import type { PendingAnnotation } from "./valid-annotation-format-internal";
 /**
- * Report an invalid @story annotation without applying a fix.
+ * Report an invalid `@story` annotation without applying a fix.
  *
- * The invalid @story annotation is detected and reported but left unchanged.
+ * The invalid `@story` annotation is detected and reported but left unchanged.
  *
  * @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
  * @story docs/stories/008.0-DEV-AUTO-FIX.story.md
@@ -44,10 +44,10 @@ import type { PendingAnnotation } from "./valid-annotation-format-internal";
  */
 export declare function reportInvalidStoryFormat(context: any, comment: any, collapsed: string, options: ResolvedAnnotationOptions): void;
 /**
- * Compute the text replacement for an invalid @story annotation within a comment.
+ * Compute the text replacement for an invalid `@story` annotation within a comment.
  *
  * This helper:
- *   - finds the @story tag in the raw comment text,
+ *   - finds the `@story` tag in the raw comment text,
  *   - computes the character range of its value,
  *   - and returns an ESLint fix that replaces only that range.
  *
@@ -59,7 +59,7 @@ export declare function reportInvalidStoryFormat(context: any, comment: any, col
  */
 export declare function createStoryFix(context: any, comment: any, fixed: string): null | (() => any);
 /**
- * Report an invalid @story annotation and attempt a minimal, safe auto-fix
+ * Report an invalid `@story` annotation and attempt a minimal, safe auto-fix
  * for common path suffix issues by locating and replacing the path text
  * within the original comment.
  *
@@ -76,10 +76,10 @@ export declare function createStoryFix(context: any, comment: any, fixed: string
  */
 export declare function reportInvalidStoryFormatWithFix(context: any, comment: any, collapsed: string, fixed: string): void;
 /**
- * Validate a @story annotation value and report detailed errors when needed.
+ * Validate a `@story` annotation value and report detailed errors when needed.
  * Where safe and unambiguous, apply an automatic fix for missing suffixes.
  *
- * Processing of @story values includes:
+ * Processing of `@story` values includes:
  *   - trimming whitespace,
  *   - collapsing multi-line text,
  *   - matching against the configured story regex,
@@ -97,7 +97,7 @@ export declare function reportInvalidStoryFormatWithFix(context: any, comment: a
  */
 export declare function validateStoryAnnotation(context: any, comment: any, rawValue: string, options: ResolvedAnnotationOptions): void;
 /**
- * Validate a @req annotation value and report detailed errors when needed.
+ * Validate a `@req` annotation value and report detailed errors when needed.
  *
  * This behavior covers:
  *   - detecting missing identifiers,
@@ -115,14 +115,14 @@ export declare function validateStoryAnnotation(context: any, comment: any, rawV
  */
 export declare function validateReqAnnotation(context: any, comment: any, rawValue: string, options: ResolvedAnnotationOptions): void;
 /**
- * Validate an @supports annotation value and report detailed errors when needed.
+ * Validate an `@supports` annotation value and report detailed errors when needed.
  *
  * Expected format:
- *   @supports <storyPath> <REQ-ID> [<REQ-ID> ...]
+ *   `@supports <storyPath> <REQ-ID> [<REQ-ID> ...]`
  *
  * Validation rules:
  *   - Value must include at least a story path and one requirement ID.
- *   - Story path must match the same storyPattern used for @story (no auto-fix).
+ *   - Story path must match the same storyPattern used for `@story` (no auto-fix).
  *   - Each subsequent token must match reqPattern and is validated individually.
  *
  * Story path issues are reported with "invalidImplementsFormat" and

package/lib/src/rules/helpers/valid-annotation-format-validators.js

@@ -8,9 +8,9 @@
  * to read while still preserving all existing behavior.
  *
  * The implementation in this module supports:
- * - validation of @story annotations
- * - validation of @req annotations
- * - validation of @implements/@supports-style annotations
+ * - validation of `@story` annotations
+ * - validation of `@req` annotations
+ * - validation of `@implements`/`@supports`-style annotations
  * - safe, minimal auto-fixes for certain invalid formats
  *
  * @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
@@ -43,9 +43,9 @@ const valid_annotation_utils_1 = require("./valid-annotation-utils");
 const valid_implements_utils_1 = require("./valid-implements-utils");
 const valid_annotation_options_1 = require("./valid-annotation-options");
 /**
- * Report an invalid @story annotation without applying a fix.
+ * Report an invalid `@story` annotation without applying a fix.
  *
- * The invalid @story annotation is detected and reported but left unchanged.
+ * The invalid `@story` annotation is detected and reported but left unchanged.
  *
  * @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
  * @story docs/stories/008.0-DEV-AUTO-FIX.story.md
@@ -60,10 +60,10 @@ function reportInvalidStoryFormat(context, comment, collapsed, options) {
     });
 }
 /**
- * Compute the text replacement for an invalid @story annotation within a comment.
+ * Compute the text replacement for an invalid `@story` annotation within a comment.
  *
  * This helper:
- *   - finds the @story tag in the raw comment text,
+ *   - finds the `@story` tag in the raw comment text,
  *   - computes the character range of its value,
  *   - and returns an ESLint fix that replaces only that range.
  *
@@ -103,7 +103,7 @@ function createStoryFix(context, comment, fixed) {
     return () => (fixer) => fixer.replaceTextRange(fixRange, fixed);
 }
 /**
- * Report an invalid @story annotation and attempt a minimal, safe auto-fix
+ * Report an invalid `@story` annotation and attempt a minimal, safe auto-fix
  * for common path suffix issues by locating and replacing the path text
  * within the original comment.
  *
@@ -136,10 +136,10 @@ function reportInvalidStoryFormatWithFix(context, comment, collapsed, fixed) {
     });
 }
 /**
- * Validate a @story annotation value and report detailed errors when needed.
+ * Validate a `@story` annotation value and report detailed errors when needed.
  * Where safe and unambiguous, apply an automatic fix for missing suffixes.
  *
- * Processing of @story values includes:
+ * Processing of `@story` values includes:
  *   - trimming whitespace,
  *   - collapsing multi-line text,
  *   - matching against the configured story regex,
@@ -194,7 +194,7 @@ function validateStoryAnnotation(context, comment, rawValue, options) {
     reportInvalidStoryFormat(context, comment, collapsed, options);
 }
 /**
- * Validate a @req annotation value and report detailed errors when needed.
+ * Validate a `@req` annotation value and report detailed errors when needed.
  *
  * This behavior covers:
  *   - detecting missing identifiers,
@@ -222,33 +222,42 @@ function validateReqAnnotation(context, comment, rawValue, options) {
         });
         return;
     }
-    const collapsed = (0, valid_annotation_utils_1.collapseAnnotationValue)(trimmed);
-    // Allow mixed @req/@supports lines to pass without additional @req validation,
-    // while still validating simple multi-line @req identifiers that collapse
-    // to a single token.
-    if (collapsed.includes("@supports")) {
+    // Allow mixed `@req`/`@supports` lines to pass without additional `@req` validation.
+    if (trimmed.includes("@supports")) {
         return;
     }
-    const reqPattern = options.reqPattern;
+    const tokens = trimmed.split(/\s+/).filter(Boolean);
+    let reqId = tokens[0] || trimmed;
+    for (let index = 1; index < tokens.length; index += 1) {
+        const token = tokens[index];
+        if (token === "-" || token === "–" || token === "—")
+            break;
+        const candidate = `${reqId}${token}`;
+        if (reqId.endsWith("-") || options.reqPattern.test(candidate)) {
+            reqId = candidate;
+            continue;
+        }
+        break;
+    }
     // @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
     // @req REQ-REQ-FORMAT - Flag @req identifiers that do not match the configured pattern
-    if (!reqPattern.test(collapsed)) {
+    if (!options.reqPattern.test(reqId)) {
         context.report({
             node: comment,
             messageId: "invalidReqFormat",
-            data: { details: (0, valid_annotation_utils_1.buildReqErrorMessage)("invalid", collapsed, options) },
+            data: { details: (0, valid_annotation_utils_1.buildReqErrorMessage)("invalid", reqId, options) },
         });
     }
 }
 /**
- * Validate an @supports annotation value and report detailed errors when needed.
+ * Validate an `@supports` annotation value and report detailed errors when needed.
  *
  * Expected format:
- *   @supports <storyPath> <REQ-ID> [<REQ-ID> ...]
+ *   `@supports <storyPath> <REQ-ID> [<REQ-ID> ...]`
  *
  * Validation rules:
  *   - Value must include at least a story path and one requirement ID.
- *   - Story path must match the same storyPattern used for @story (no auto-fix).
+ *   - Story path must match the same storyPattern used for `@story` (no auto-fix).
  *   - Each subsequent token must match reqPattern and is validated individually.
  *
  * Story path issues are reported with "invalidImplementsFormat" and

package/lib/src/rules/helpers/valid-annotation-options.d.ts

@@ -1,13 +1,3 @@
-/**
- * Shared option handling for the valid-annotation-format rule.
- *
- * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
- * @req REQ-PATTERN-CONFIG - Support configuration of custom story path and requirement ID patterns
- * @req REQ-REGEX-VALIDATION - Validate that configured patterns are valid regular expressions
- * @req REQ-BACKWARD-COMPAT - Maintain current behavior when no custom patterns configured
- * @req REQ-EXAMPLE-MESSAGES - Support optional example strings in error messages
- * @req REQ-SCHEMA-VALIDATION - Use JSON Schema to validate configuration options
- */
 export interface AnnotationRuleOptions {
     story?: {
         /**

package/lib/src/rules/helpers/valid-annotation-options.js

@@ -5,6 +5,17 @@ exports.getResolvedDefaults = getResolvedDefaults;
 exports.getOptionErrors = getOptionErrors;
 exports.resolveOptions = resolveOptions;
 exports.getRuleSchema = getRuleSchema;
+/**
+ * Shared option handling for the valid-annotation-format rule.
+ *
+ * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
+ * @req REQ-PATTERN-CONFIG - Support configuration of custom story path and requirement ID patterns
+ * @req REQ-REGEX-VALIDATION - Validate that configured patterns are valid regular expressions
+ * @req REQ-BACKWARD-COMPAT - Maintain current behavior when no custom patterns configured
+ * @req REQ-EXAMPLE-MESSAGES - Support optional example strings in error messages
+ * @req REQ-SCHEMA-VALIDATION - Use JSON Schema to validate configuration options
+ */
+const pattern_validators_1 = require("./pattern-validators");
 /**
  * Get the default regular expression used to validate story paths.
  *
@@ -84,92 +95,6 @@ function getOptionErrors() {
  * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
  * @req REQ-PATTERN-CONFIG - Provide consistent regex validation diagnostics
  */
-function buildInvalidRegexError(field, pattern) {
-    return `Invalid regular expression for option "${field}": "${pattern}"`;
-}
-/**
- * Normalize raw rule options into a single AnnotationRuleOptions object.
- *
- * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
- * @req REQ-PATTERN-CONFIG
- * @req REQ-BACKWARD-COMPAT
- */
-function normalizeUserOptions(rawOptions) {
-    if (!rawOptions || rawOptions.length === 0) {
-        return undefined;
-    }
-    const first = rawOptions[0];
-    if (!first || typeof first !== "object") {
-        return undefined;
-    }
-    return first;
-}
-/**
- * Resolve a user-configured regex pattern, handling both nested and flat
- * configuration shapes and accumulating validation errors.
- *
- * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
- * @req REQ-PATTERN-CONFIG
- * @req REQ-REGEX-VALIDATION
- * @req REQ-BACKWARD-COMPAT
- */
-function resolvePattern({ nestedPattern, nestedFieldName, flatPattern, flatFieldName, defaultPattern, }) {
-    const effective = typeof nestedPattern === "string"
-        ? { value: nestedPattern, field: nestedFieldName }
-        : typeof flatPattern === "string"
-            ? { value: flatPattern, field: flatFieldName }
-            : null;
-    if (!effective) {
-        return defaultPattern;
-    }
-    try {
-        return new RegExp(effective.value);
-    }
-    catch {
-        optionErrors.push(buildInvalidRegexError(effective.field, effective.value));
-        return defaultPattern;
-    }
-}
-/**
- * Resolve an example string, preferring nested over flat configuration,
- * and falling back to the provided default when necessary.
- *
- * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
- * @req REQ-EXAMPLE-MESSAGES
- * @req REQ-BACKWARD-COMPAT
- */
-function resolveExample(nestedExample, flatExample, defaultExample) {
-    if (typeof nestedExample === "string" && nestedExample.trim()) {
-        return nestedExample;
-    }
-    if (typeof flatExample === "string" && flatExample.trim()) {
-        return flatExample;
-    }
-    return defaultExample;
-}
-/**
- * Extract and normalize user-provided options from the raw ESLint
- * options array into an AnnotationRuleOptions object.
- *
- * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
- * @req REQ-PATTERN-CONFIG - Accept structured configuration for patterns
- * @req REQ-BACKWARD-COMPAT - Tolerate missing or malformed options
- */
-function getUserOptions(rawOptions) {
-    return normalizeUserOptions(rawOptions);
-}
-/**
- * Resolve the auto-fix flag, defaulting to true when the option
- * is not explicitly provided by the user.
- *
- * @story docs/stories/010.1-DEV-CONFIGURABLE-PATTERNS.story.md
- * @req REQ-PATTERN-CONFIG - Support configuration of fix behavior
- * @req REQ-BACKWARD-COMPAT - Preserve default auto-fix behavior
- */
-function resolveAutoFixFlag(user) {
-    const autoFixFlag = user?.autoFix;
-    return typeof autoFixFlag === "boolean" ? autoFixFlag : true;
-}
 /**
  * Resolve the story path pattern from nested or flat configuration
  * fields, validating and falling back to the default as needed.
@@ -180,12 +105,13 @@ function resolveAutoFixFlag(user) {
  * @req REQ-BACKWARD-COMPAT - Use a default when no pattern is provided
  */
 function resolveStoryPattern(nestedStoryPattern, flatStoryPattern) {
-    return resolvePattern({
+    return (0, pattern_validators_1.resolvePattern)({
         nestedPattern: nestedStoryPattern,
         nestedFieldName: "story.pattern",
         flatPattern: flatStoryPattern,
         flatFieldName: "storyPathPattern",
         defaultPattern: getDefaultStoryPattern(),
+        errors: optionErrors,
     });
 }
 /**
@@ -198,12 +124,13 @@ function resolveStoryPattern(nestedStoryPattern, flatStoryPattern) {
  * @req REQ-BACKWARD-COMPAT - Use a default when no pattern is provided
  */
 function resolveReqPattern(nestedReqPattern, flatReqPattern) {
-    return resolvePattern({
+    return (0, pattern_validators_1.resolvePattern)({
         nestedPattern: nestedReqPattern,
         nestedFieldName: "req.pattern",
         flatPattern: flatReqPattern,
         flatFieldName: "requirementIdPattern",
         defaultPattern: getDefaultReqPattern(),
+        errors: optionErrors,
     });
 }
 /**
@@ -215,7 +142,7 @@ function resolveReqPattern(nestedReqPattern, flatReqPattern) {
  * @req REQ-BACKWARD-COMPAT - Use a default story example when omitted
  */
 function resolveStoryExample(nestedStoryExample, flatStoryExample) {
-    return resolveExample(nestedStoryExample, flatStoryExample, getDefaultStoryExample());
+    return (0, pattern_validators_1.resolveExample)(nestedStoryExample, flatStoryExample, getDefaultStoryExample());
 }
 /**
  * Resolve the requirement ID example string from nested or flat configuration
@@ -226,7 +153,7 @@ function resolveStoryExample(nestedStoryExample, flatStoryExample) {
  * @req REQ-BACKWARD-COMPAT - Use a default requirement ID example when omitted
  */
 function resolveReqExample(nestedReqExample, flatReqExample) {
-    return resolveExample(nestedReqExample, flatReqExample, getDefaultReqExample());
+    return (0, pattern_validators_1.resolveExample)(nestedReqExample, flatReqExample, getDefaultReqExample());
 }
 /**
  * Collect user-provided story pattern inputs from both nested and flat
@@ -298,7 +225,8 @@ function resolveOptionsInternal(user) {
     const { nestedStoryExample, flatStoryExample } = getStoryExampleInputs(user);
     const { nestedReqPattern, flatReqPattern } = getReqPatternInputs(user);
     const { nestedReqExample, flatReqExample } = getReqExampleInputs(user);
-    const autoFix = resolveAutoFixFlag(user);
+    const autoFixFlag = user?.autoFix;
+    const autoFix = typeof autoFixFlag === "boolean" ? autoFixFlag : true;
     const storyPattern = resolveStoryPattern(nestedStoryPattern, flatStoryPattern);
     const reqPattern = resolveReqPattern(nestedReqPattern, flatReqPattern);
     const storyExample = resolveStoryExample(nestedStoryExample, flatStoryExample);
@@ -322,7 +250,9 @@ function resolveOptionsInternal(user) {
  */
 function resolveOptions(rawOptions) {
     optionErrors = [];
-    const user = getUserOptions(rawOptions);
+    const user = rawOptions && rawOptions.length > 0 && typeof rawOptions[0] === "object"
+        ? rawOptions[0]
+        : undefined;
     const resolved = resolveOptionsInternal(user);
     resolvedDefaults = resolved;
     return resolvedDefaults;

package/lib/src/rules/helpers/valid-annotation-utils.js

@@ -5,6 +5,7 @@ exports.collapseAnnotationValue = collapseAnnotationValue;
 exports.getFixedStoryPath = getFixedStoryPath;
 exports.buildStoryErrorMessage = buildStoryErrorMessage;
 exports.buildReqErrorMessage = buildReqErrorMessage;
+/* eslint-disable traceability/valid-annotation-format */
 const valid_annotation_options_1 = require("./valid-annotation-options");
 /**
  * Shared constants and helpers for annotation-format validation.

package/lib/src/rules/helpers/valid-req-reference-helpers.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createValidReqReferenceProgramVisitor = createValidReqReferenceProgramVisitor;
-/* eslint-env node */
+/* eslint-disable traceability/valid-annotation-format */
 /**
  * Helper utilities for the "valid-req-reference" rule.
  *