eslint-plugin-traceability 1.4.6 → 1.4.7

package/lib/src/index.d.ts

@@ -6,7 +6,7 @@
  */
 import type { Rule } from "eslint";
 /**
- * @story docs/stories/001.2-RULE-NAMES-DECLARATION.story.md
+ * @story docs/stories/002.0-DYNAMIC-RULE-LOADING.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"];

package/lib/src/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configs = exports.rules = void 0;
 /**
- * @story docs/stories/001.2-RULE-NAMES-DECLARATION.story.md
+ * @story docs/stories/002.0-DYNAMIC-RULE-LOADING.story.md
  * @req REQ-RULE-LIST - Enumerate supported rule file names for plugin discovery
  */
 const RULE_NAMES = [

package/lib/tests/rules/require-story-core.autofix.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/tests/rules/require-story-core.autofix.test.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Tests for: docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-AUTOFIX - Cover additional branch cases in require-story-core (addStoryFixer/reportMissing)
+ */
+const require_story_core_1 = require("../../src/rules/helpers/require-story-core");
+const require_story_helpers_1 = require("../../src/rules/helpers/require-story-helpers");
+describe("Require Story Core (Story 003.0)", () => {
+    test("createAddStoryFix falls back to 0 when target is falsy", () => {
+        const fixer = {
+            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
+        };
+        const fixFn = (0, require_story_core_1.createAddStoryFix)(null);
+        const res = fixFn(fixer);
+        expect(fixer.insertTextBeforeRange).toHaveBeenCalledTimes(1);
+        const args = fixer.insertTextBeforeRange.mock.calls[0];
+        expect(args[0]).toEqual([0, 0]);
+        expect(args[1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
+        expect(res).toEqual({ r: [0, 0], t: `${require_story_helpers_1.ANNOTATION}\n` });
+    });
+    test("createAddStoryFix uses target.range when parent not export and parent.range missing", () => {
+        const target = {
+            type: "FunctionDeclaration",
+            range: [21, 33],
+            parent: { type: "ClassBody" },
+        };
+        const fixer = {
+            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
+        };
+        const fixFn = (0, require_story_core_1.createAddStoryFix)(target);
+        const res = fixFn(fixer);
+        expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([21, 21]);
+        expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
+        expect(res).toEqual({ r: [21, 21], t: `${require_story_helpers_1.ANNOTATION}\n` });
+    });
+    test("createAddStoryFix prefers ExportDefaultDeclaration parent.range when present", () => {
+        const target = {
+            type: "FunctionDeclaration",
+            range: [50, 70],
+            parent: { type: "ExportDefaultDeclaration", range: [5, 100] },
+        };
+        const fixer = {
+            insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
+        };
+        const fixFn = (0, require_story_core_1.createAddStoryFix)(target);
+        const res = fixFn(fixer);
+        expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([5, 5]);
+        expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(`${require_story_helpers_1.ANNOTATION}\n`);
+        expect(res).toEqual({ r: [5, 5], t: `${require_story_helpers_1.ANNOTATION}\n` });
+    });
+    test("reportMissing uses context.getSourceCode fallback when sourceCode not provided and still reports", () => {
+        const node = {
+            type: "FunctionDeclaration",
+            id: { name: "fnX" },
+            range: [0, 10],
+        };
+        const fakeSource = {
+            /* intentionally missing getJSDocComment to exercise branch */ getText: () => "",
+        };
+        const context = { getSourceCode: () => fakeSource, report: jest.fn() };
+        (0, require_story_core_1.reportMissing)(context, undefined, node, node);
+        expect(context.report).toHaveBeenCalledTimes(1);
+        const call = context.report.mock.calls[0][0];
+        expect(call.node).toBe(node);
+        expect(call.messageId).toBe("missingStory");
+    });
+});

package/lib/tests/rules/require-story-core.branches.test.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const require_story_core_1 = require("../../src/rules/helpers/require-story-core");
 const require_story_helpers_1 = require("../../src/rules/helpers/require-story-helpers");
-describe("Require Story Core branches (Story 003.0)", () => {
+describe("Require Story Core (Story 003.0)", () => {
     test("createAddStoryFix falls back to 0 when target is falsy", () => {
         const fixer = {
             insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.4.6",
+  "version": "1.4.7",
   "description": "A customizable ESLint plugin that enforces traceability annotations in your code, ensuring each implementation is linked to its requirement or test case.",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",
@@ -16,12 +16,13 @@
     "build": "tsc -p tsconfig.json",
     "type-check": "tsc --noEmit -p tsconfig.json",
     "check:traceability": "node scripts/traceability-check.js",
-    "lint-plugin-check": "npm run build && node scripts/lint-plugin-check.js",
-    "lint:require-built-plugin": "npm run lint-plugin-check",
+    "lint-plugin-check": "node scripts/lint-plugin-check.js",
+    "lint-plugin-guard": "node scripts/lint-plugin-guard.js",
+    "lint:require-built-plugin": "npm run lint-plugin-guard",
     "lint": "eslint --config eslint.config.js \"src/**/*.{js,ts}\" \"tests/**/*.{js,ts}\" --max-warnings=0",
     "test": "jest --ci --bail",
     "ci-verify": "npm run type-check && npm run lint && npm run format:check && npm run duplication && npm run check:traceability && npm test && npm run audit:ci && npm run safety:deps",
-    "ci-verify:fast": "npm run lint-plugin-check && npm run type-check && npm run check:traceability && npm run duplication && jest --ci --bail --passWithNoTests --testPathPatterns 'tests/(unit|fast)'",
+    "ci-verify:fast": "npm run lint:require-built-plugin && npm run type-check && npm run check:traceability && npm run duplication && jest --ci --bail --passWithNoTests --testPathPatterns 'tests/(unit|fast)'",
     "format": "prettier --write .",
     "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
     "duplication": "jscpd src tests --reporters console --threshold 3 --ignore tests/utils/**",