eslint-plugin-traceability 1.7.1 → 1.8.1

package/lib/tests/maintenance/cli.test.js

@@ -145,6 +145,31 @@ describe("Maintenance CLI (Story 009.0-DEV-MAINTENANCE-TOOLS)", () => {
             fs_1.default.rmSync(dir, { recursive: true, force: true });
         }
     });
+    it("[REQ-MAINT-SAFE] report exits 2 and prints error on invalid --format value", () => {
+        const dir = withTempDir();
+        process.chdir(dir);
+        const errorSpy = jest.spyOn(console, "error").mockImplementation(() => { });
+        const logSpy = jest.spyOn(console, "log").mockImplementation(() => { });
+        const code = (0, cli_1.runMaintenanceCli)([
+            "node",
+            "traceability-maint",
+            "report",
+            "--format",
+            "yaml",
+        ]);
+        try {
+            expect(code).toBe(2);
+            expect(errorSpy).toHaveBeenCalledTimes(1);
+            const message = String(errorSpy.mock.calls[0][0]);
+            expect(message).toContain("Invalid format: yaml");
+            expect(message).toContain("Expected 'text' or 'json'");
+        }
+        finally {
+            errorSpy.mockRestore();
+            logSpy.mockRestore();
+            fs_1.default.rmSync(dir, { recursive: true, force: true });
+        }
+    });
     it("[REQ-MAINT-DETECT] detect supports --json output", () => {
         const dir = withTempDir();
         process.chdir(dir);
@@ -169,4 +194,68 @@ describe("Maintenance CLI (Story 009.0-DEV-MAINTENANCE-TOOLS)", () => {
             fs_1.default.rmSync(dir, { recursive: true, force: true });
         }
     });
+    it("[REQ-MAINT-DETECT] detect with non-existent --root exits 0 and reports no stale annotations", () => {
+        const dir = withTempDir();
+        process.chdir(dir);
+        const missingRoot = path_1.default.join(dir, "missing-root");
+        const logSpy = jest.spyOn(console, "log").mockImplementation(() => { });
+        const code = (0, cli_1.runMaintenanceCli)([
+            "node",
+            "traceability-maint",
+            "detect",
+            "--root",
+            missingRoot,
+        ]);
+        try {
+            expect(code).toBe(0);
+            expect(logSpy).toHaveBeenCalledWith("No stale @story annotations found.");
+        }
+        finally {
+            logSpy.mockRestore();
+            fs_1.default.rmSync(dir, { recursive: true, force: true });
+        }
+    });
+    it("[REQ-MAINT-SAFE] prints help and exits 0 when no subcommand is provided", () => {
+        const dir = withTempDir();
+        process.chdir(dir);
+        const logSpy = jest.spyOn(console, "log").mockImplementation(() => { });
+        const errorSpy = jest.spyOn(console, "error").mockImplementation(() => { });
+        const code = (0, cli_1.runMaintenanceCli)(["node", "traceability-maint"]);
+        try {
+            expect(code).toBe(0);
+            expect(logSpy).toHaveBeenCalled();
+            const allMessages = logSpy.mock.calls.flat().join("\n");
+            expect(allMessages).toContain("traceability-maint - Traceability annotation maintenance tools");
+            expect(errorSpy).not.toHaveBeenCalled();
+        }
+        finally {
+            logSpy.mockRestore();
+            errorSpy.mockRestore();
+            fs_1.default.rmSync(dir, { recursive: true, force: true });
+        }
+    });
+    it("[REQ-MAINT-SAFE] detect catches filesystem permission errors and exits 2 with prefixed error message", () => {
+        const dir = withTempDir();
+        process.chdir(dir);
+        const errorSpy = jest.spyOn(console, "error").mockImplementation(() => { });
+        const logSpy = jest.spyOn(console, "log").mockImplementation(() => { });
+        const statSpy = jest.spyOn(fs_1.default, "statSync").mockImplementation(() => {
+            const err = new Error("EACCES simulated");
+            err.code = "EACCES";
+            throw err;
+        });
+        const code = (0, cli_1.runMaintenanceCli)(["node", "traceability-maint", "detect"]);
+        try {
+            expect(code).toBe(2);
+            expect(errorSpy).toHaveBeenCalled();
+            const message = String(errorSpy.mock.calls[0][0]);
+            expect(message).toContain("traceability-maint failed:");
+        }
+        finally {
+            statSpy.mockRestore();
+            errorSpy.mockRestore();
+            logSpy.mockRestore();
+            fs_1.default.rmSync(dir, { recursive: true, force: true });
+        }
+    });
 });

package/lib/tests/plugin-default-export-and-configs.test.js

@@ -80,12 +80,10 @@ describe("Plugin Default Export and Configs (Story 001.0-DEV-PLUGIN-SETUP)", ()
         expect(recommendedRules).toHaveProperty("traceability/require-branch-annotation", "error");
         expect(recommendedRules).toHaveProperty("traceability/valid-story-reference", "error");
         expect(recommendedRules).toHaveProperty("traceability/valid-req-reference", "error");
-        expect(recommendedRules).toHaveProperty("traceability/prefer-implements-annotation", "warn");
     });
     it("[REQ-ERROR-SEVERITY] configs.strict uses same severity mapping as recommended", () => {
         const strictRules = index_1.configs.strict[0].rules;
         const recommendedRules = index_1.configs.recommended[0].rules;
         expect(strictRules).toEqual(recommendedRules);
-        expect(strictRules).toHaveProperty("traceability/prefer-implements-annotation", "warn");
     });
 });

package/lib/tests/rules/prefer-implements-annotation.test.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const eslint_1 = require("eslint");
 const prefer_implements_annotation_1 = __importDefault(require("../../src/rules/prefer-implements-annotation"));
+const src_1 = require("../../src");
 const ruleTester = new eslint_1.RuleTester({
     languageOptions: {
         parserOptions: { ecmaVersion: 2020, sourceType: "module" },
@@ -82,3 +83,30 @@ describe("prefer-implements-annotation rule (Story 010.3-DEV-MIGRATE-TO-IMPLEMEN
         ],
     });
 });
+describe("prefer-implements-annotation configuration severity (REQ-CONFIG-SEVERITY)", () => {
+    test("rule is disabled by default in recommended preset (not present in configs.recommended[0].rules)", () => {
+        const recommended = src_1.configs.recommended;
+        expect(Array.isArray(recommended)).toBe(true);
+        const firstConfig = recommended[0];
+        expect(firstConfig).toBeDefined();
+        const rules = firstConfig.rules || {};
+        expect(rules["@eslint-sweat/prefer-implements-annotation"]).toBeUndefined();
+        expect(rules["prefer-implements-annotation"]).toBeUndefined();
+    });
+    test("rule can be configured with severity 'warn' or 'error' in flat config", () => {
+        const flatWarnConfig = {
+            files: ["**/*.ts"],
+            rules: {
+                "prefer-implements-annotation": "warn",
+            },
+        };
+        expect(flatWarnConfig.rules["prefer-implements-annotation"]).toBe("warn");
+        const flatErrorConfig = {
+            files: ["**/*.ts"],
+            rules: {
+                "prefer-implements-annotation": "error",
+            },
+        };
+        expect(flatErrorConfig.rules["prefer-implements-annotation"]).toBe("error");
+    });
+});

package/lib/tests/rules/require-req-annotation.test.js

@@ -12,6 +12,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  *
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-TYPESCRIPT-SUPPORT - Verify TypeScript declarations are checked via shared annotation checker helper
+ *
+ * @story docs/stories/010.2-DEV-MULTI-STORY-SUPPORT.story.md
+ * @req REQ-REQUIRE-ACCEPTS-IMPLEMENTS - Verify @implements is accepted as satisfying requirement annotations
  */
 const eslint_1 = require("eslint");
 const require_req_annotation_1 = __importDefault(require("../../src/rules/require-req-annotation"));
@@ -73,6 +76,10 @@ describe("Require Req Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", (
                 name: "[REQ-ANNOTATION-REQUIRED] valid with only @req annotation",
                 code: `/**\n * @req REQ-EXAMPLE\n */\nfunction foo() {}`,
             },
+            {
+                name: "[REQ-REQUIRE-ACCEPTS-IMPLEMENTS] valid with only @implements annotation",
+                code: `/**\n * @implements docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ANNOTATION-REQUIRED\n */\nfunction implOnly() {}`,
+            },
             {
                 name: "[REQ-ANNOTATION-REQUIRED] valid with @story and @req annotations",
                 code: `/**\n * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md\n * @req REQ-EXAMPLE\n */\nfunction bar() {}`,
@@ -131,7 +138,7 @@ describe("Require Req Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", (
         ],
         invalid: [
             {
-                name: "[REQ-ANNOTATION-REQUIRED] missing @req on function without JSDoc",
+                name: "[REQ-ANNOTATION-REQUIRED][REQ-REQUIRE-ACCEPTS-IMPLEMENTS] missing @req on function without JSDoc remains invalid under multi-story support",
                 code: `function baz() {}`,
                 errors: [
                     {

package/lib/tests/rules/require-story-annotation.test.js

@@ -6,15 +6,15 @@ 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
+ * @story docs/stories/010.2-DEV-MULTI-STORY-SUPPORT.story.md
  * @req REQ-ANNOTATION-REQUIRED - Verify require-story-annotation rule enforces @story annotation on functions
+ * @req REQ-REQUIRE-ACCEPTS-IMPLEMENTS - Verify @implements annotation is accepted as satisfying story requirements
  */
 const eslint_1 = require("eslint");
 const require_story_annotation_1 = __importDefault(require("../../src/rules/require-story-annotation"));
 const ts_language_options_1 = require("../utils/ts-language-options");
 const ruleTester = new eslint_1.RuleTester({
-    languageOptions: {
-        parserOptions: { ecmaVersion: 2020, sourceType: "module" },
-    },
+    languageOptions: ts_language_options_1.tsRuleTesterLanguageOptions,
 });
 describe("Require Story Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", () => {
     ruleTester.run("require-story-annotation", require_story_annotation_1.default, {
@@ -23,6 +23,10 @@ describe("Require Story Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)",
                 name: "[REQ-ANNOTATION-REQUIRED] valid with JSDoc @story annotation",
                 code: `/**\n * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md\n */\nfunction foo() {}`,
             },
+            {
+                name: "[REQ-REQUIRE-ACCEPTS-IMPLEMENTS] valid with only @implements annotation",
+                code: `/**\n * @implements docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md REQ-ANNOTATION-REQUIRED\n */\nfunction implOnly() {}`,
+            },
             {
                 name: "[REQ-ANNOTATION-REQUIRED] valid with line comment @story annotation",
                 code: `// @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
@@ -60,7 +64,8 @@ declare function tsDecl(): void;`,
         ],
         invalid: [
             {
-                name: "[REQ-ANNOTATION-REQUIRED] missing @story annotation on function",
+                // Backward compatibility: plain unannotated functions remain invalid under multi-story support
+                name: "[REQ-ANNOTATION-REQUIRED][BACKCOMPAT] missing @story annotation on function with no @implements",
                 code: `function bar() {}`,
                 output: `/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\nfunction bar() {}`,
                 errors: [

package/lib/tests/utils/ts-language-options.d.ts

@@ -3,13 +3,7 @@
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-TYPESCRIPT-SUPPORT - Provide reusable TypeScript parser setup for tests
  */
-export declare const tsRuleTesterLanguageOptions: {
-    readonly parser: any;
-    readonly parserOptions: {
-        readonly ecmaVersion: 2022;
-        readonly sourceType: "module";
-    };
-};
+export declare const tsRuleTesterLanguageOptions: any;
 /**
  * Attach shared TypeScript RuleTester language options to a test case definition.
  * This helper allows tests to avoid repeating the languageOptions assignment.

package/lib/tests/utils/ts-language-options.js

@@ -1,16 +1,19 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tsRuleTesterLanguageOptions = void 0;
-exports.withTsLanguageOptions = withTsLanguageOptions;
 /**
  * Shared TypeScript RuleTester language options for traceability tests.
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-TYPESCRIPT-SUPPORT - Provide reusable TypeScript parser setup for tests
  */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tsRuleTesterLanguageOptions = void 0;
+exports.withTsLanguageOptions = withTsLanguageOptions;
+const tsEcmaVersion = 2022;
 exports.tsRuleTesterLanguageOptions = {
     parser: require("@typescript-eslint/parser"),
-    // eslint-disable-next-line no-magic-numbers -- ECMAScript version constant
-    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+    parserOptions: {
+        ecmaVersion: tsEcmaVersion,
+        sourceType: "module",
+    },
 };
 /**
  * Attach shared TypeScript RuleTester language options to a test case definition.

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.7.1",
+  "version": "1.8.1",
   "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",
   "files": [
     "lib",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "SECURITY.md",
+    "user-docs",
+    "CHANGELOG.md"
   ],
   "directories": {
     "doc": "docs"
@@ -27,11 +30,12 @@
     "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:full": "npm run check:traceability && npm run safety:deps && npm run audit:ci && npm run build && npm run type-check && npm run lint-plugin-check && npm run lint -- --max-warnings=0 && npm run duplication && npm run test -- --coverage && npm run format:check && npm audit --omit=dev --audit-level=high && npm run audit:dev-high",
-    "ci-verify:fast": "npm run type-check && npm run check:traceability && npm run duplication && jest --ci --bail --passWithNoTests --testPathPatterns 'tests/(unit|fast)'",
+    "ci-verify:fast": "npm run type-check && npm run check:traceability && npm run duplication && jest --ci --bail --passWithNoTests --testPathPatterns 'tests/(rules|maintenance)'",
     "format": "prettier --write .",
     "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
     "lint-staged": "lint-staged",
     "duplication": "jscpd src tests --reporters console --threshold 3 --ignore tests/utils/**",
+    "deps:maturity": "dry-aged-deps",
     "audit:dev-high": "node scripts/generate-dev-deps-audit.js",
     "safety:deps": "node scripts/ci-safety-deps.js",
     "audit:ci": "node scripts/ci-audit.js",
@@ -63,8 +67,8 @@
     "@eslint/js": "^9.39.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^10.3.5",
-    "@semantic-release/npm": "^10.0.6",
+    "@semantic-release/github": "12.0.2",
+    "@semantic-release/npm": "13.1.2",
     "@types/eslint": "^9.6.1",
     "@types/jest": "^30.0.0",
     "@types/node": "^24.10.1",
@@ -76,9 +80,9 @@
     "husky": "^9.1.7",
     "jest": "^30.2.0",
     "jscpd": "^4.0.5",
-    "lint-staged": "^16.2.6",
+    "lint-staged": "^16.2.7",
     "prettier": "^3.6.2",
-    "semantic-release": "^21.1.2",
+    "semantic-release": "25.0.2",
     "ts-jest": "^29.4.5",
     "typescript": "^5.9.3",
     "secretlint": "11.2.5",