eslint-plugin-traceability 1.6.5 → 1.7.0

package/lib/tests/utils/annotation-checker.test.js

@@ -1,13 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.runAnnotationCheckerTests = runAnnotationCheckerTests;
 /**
  * Tests for: docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @req REQ-TYPESCRIPT-SUPPORT - Support TypeScript-specific function syntax
+ * @req REQ-TEST-UTILS-TS-LANG - Shared TS RuleTester language options helper
  */
 const eslint_1 = require("eslint");
 const annotation_checker_1 = require("../../src/utils/annotation-checker");
+const ts_language_options_1 = require("./ts-language-options");
 const ruleTester = new eslint_1.RuleTester();
+const withTsAnnotationCheckerOptions = (test) => ({
+    ...test,
+    languageOptions: ts_language_options_1.tsRuleTesterLanguageOptions,
+});
+/**
+ * Shared helper for running tests that exercise the annotation-checker logic
+ * for TypeScript constructs.
+ *
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-TYPESCRIPT-SUPPORT - Support TypeScript-specific function syntax
+ * @req REQ-TEST-UTILS-TS-LANG - Shared TS RuleTester language options helper
+ */
+function runAnnotationCheckerTests(ruleName, config) {
+    const { rule, valid, invalid } = config;
+    ruleTester.run(ruleName, rule, {
+        valid: valid.map(withTsAnnotationCheckerOptions),
+        invalid: invalid.map(withTsAnnotationCheckerOptions),
+    });
+}
 const rule = {
     meta: {
         type: "problem",
@@ -35,23 +57,16 @@ const rule = {
     },
 };
 describe("annotation-checker helper", () => {
-    ruleTester.run("annotation-checker", rule, {
+    runAnnotationCheckerTests("annotation-checker", {
+        rule,
         valid: [
             {
                 name: "[REQ-TYPESCRIPT-SUPPORT] valid TSDeclareFunction with @req",
                 code: `/** @req REQ-TEST */\ndeclare function foo(): void;`,
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
-                },
             },
             {
                 name: "[REQ-TYPESCRIPT-SUPPORT] valid TSMethodSignature with @req",
                 code: `interface I { /** @req REQ-TEST */ method(): void; }`,
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
-                },
             },
         ],
         invalid: [
@@ -60,20 +75,12 @@ describe("annotation-checker helper", () => {
                 code: `declare function foo(): void;`,
                 output: `/** @req <REQ-ID> */\ndeclare function foo(): void;`,
                 errors: [{ messageId: "missingReq" }],
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
-                },
             },
             {
                 name: "[REQ-TYPESCRIPT-SUPPORT] missing @req on TSMethodSignature",
                 code: `interface I { method(): void; }`,
                 output: `interface I { /** @req <REQ-ID> */\nmethod(): void; }`,
                 errors: [{ messageId: "missingReq" }],
-                languageOptions: {
-                    parser: require("@typescript-eslint/parser"),
-                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
-                },
             },
         ],
     });

package/lib/tests/utils/require-story-core-test-helpers.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Shared test helpers for require-story-core branch coverage.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-AUTOFIX - Provide reusable helpers to exercise autofix branches
+ */
+interface ExerciseOptions {
+    annotationText?: string;
+}
+export declare function exerciseCreateAddStoryFixBranches(createAddStoryFix: any, options?: ExerciseOptions): void;
+export {};

package/lib/tests/utils/require-story-core-test-helpers.js

@@ -0,0 +1,75 @@
+"use strict";
+/**
+ * Shared test helpers for require-story-core branch coverage.
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-AUTOFIX - Provide reusable helpers to exercise autofix branches
+ */
+/* global jest, expect */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exerciseCreateAddStoryFixBranches = exerciseCreateAddStoryFixBranches;
+const RANGE_ONE_START = 21;
+const RANGE_ONE_END = 33;
+const RANGE_TWO_START = 50;
+const RANGE_TWO_END = 70;
+const RANGE_PARENT_START = 5;
+const RANGE_PARENT_END = 100;
+const DEFAULT_ANNOTATION = "/** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */\n";
+function baseFixer() {
+    return {
+        insertTextBeforeRange: jest.fn((r, t) => ({ r, t })),
+    };
+}
+function exerciseBranch1(createAddStoryFix, annotation) {
+    const fixer = baseFixer();
+    const fixFn = 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(annotation);
+    expect(res).toEqual({
+        r: [0, 0],
+        t: annotation,
+    });
+}
+function exerciseBranch2(createAddStoryFix, annotation) {
+    const target = {
+        type: "FunctionDeclaration",
+        range: [RANGE_ONE_START, RANGE_ONE_END],
+        parent: { type: "ClassBody" },
+    };
+    const fixer = baseFixer();
+    const fixFn = createAddStoryFix(target);
+    const res = fixFn(fixer);
+    expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([RANGE_ONE_START, RANGE_ONE_START]);
+    expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(annotation);
+    expect(res).toEqual({
+        r: [RANGE_ONE_START, RANGE_ONE_START],
+        t: annotation,
+    });
+}
+function exerciseBranch3(createAddStoryFix, annotation) {
+    const target = {
+        type: "FunctionDeclaration",
+        range: [RANGE_TWO_START, RANGE_TWO_END],
+        parent: {
+            type: "ExportDefaultDeclaration",
+            range: [RANGE_PARENT_START, RANGE_PARENT_END],
+        },
+    };
+    const fixer = baseFixer();
+    const fixFn = createAddStoryFix(target);
+    const res = fixFn(fixer);
+    expect(fixer.insertTextBeforeRange.mock.calls[0][0]).toEqual([RANGE_PARENT_START, RANGE_PARENT_START]);
+    expect(fixer.insertTextBeforeRange.mock.calls[0][1]).toBe(annotation);
+    expect(res).toEqual({
+        r: [RANGE_PARENT_START, RANGE_PARENT_START],
+        t: annotation,
+    });
+}
+function exerciseCreateAddStoryFixBranches(createAddStoryFix, options = {}) {
+    const annotation = options.annotationText ?? DEFAULT_ANNOTATION;
+    exerciseBranch1(createAddStoryFix, annotation);
+    exerciseBranch2(createAddStoryFix, annotation);
+    exerciseBranch3(createAddStoryFix, annotation);
+}

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

@@ -0,0 +1,22 @@
+/**
+ * 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
+ */
+export declare const tsRuleTesterLanguageOptions: {
+    readonly parser: any;
+    readonly parserOptions: {
+        readonly ecmaVersion: 2022;
+        readonly sourceType: "module";
+    };
+};
+/**
+ * Attach shared TypeScript RuleTester language options to a test case definition.
+ * This helper allows tests to avoid repeating the languageOptions assignment.
+ *
+ * @param testCase A RuleTester valid/invalid test case object
+ * @returns The same test case with TypeScript language options applied
+ */
+export declare function withTsLanguageOptions<T extends Record<string, unknown>>(testCase: T): T & {
+    languageOptions: typeof tsRuleTesterLanguageOptions;
+};

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

@@ -0,0 +1,27 @@
+"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
+ */
+exports.tsRuleTesterLanguageOptions = {
+    parser: require("@typescript-eslint/parser"),
+    // eslint-disable-next-line no-magic-numbers -- ECMAScript version constant
+    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+};
+/**
+ * Attach shared TypeScript RuleTester language options to a test case definition.
+ * This helper allows tests to avoid repeating the languageOptions assignment.
+ *
+ * @param testCase A RuleTester valid/invalid test case object
+ * @returns The same test case with TypeScript language options applied
+ */
+function withTsLanguageOptions(testCase) {
+    return {
+        ...testCase,
+        languageOptions: exports.tsRuleTesterLanguageOptions,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.6.5",
+  "version": "1.7.0",
   "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",
@@ -12,8 +12,12 @@
   "directories": {
     "doc": "docs"
   },
+  "bin": {
+    "traceability-maint": "lib/src/maintenance/cli.js"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.json",
+    "prepare": "husky install",
     "type-check": "tsc --noEmit -p tsconfig.json",
     "check:traceability": "node scripts/traceability-check.js",
     "lint-plugin-check": "node scripts/lint-plugin-check.js",
@@ -26,10 +30,12 @@
     "ci-verify:fast": "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\"",
+    "lint-staged": "lint-staged",
     "duplication": "jscpd src tests --reporters console --threshold 3 --ignore tests/utils/**",
     "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",
+    "security:secrets": "secretlint \"**/*\" --no-color",
     "smoke-test": "./scripts/smoke-test.sh"
   },
   "lint-staged": {
@@ -65,6 +71,7 @@
     "@typescript-eslint/parser": "^8.46.4",
     "@typescript-eslint/utils": "^8.46.4",
     "actionlint": "^2.0.6",
+    "dry-aged-deps": "^2.3.1",
     "eslint": "^9.39.1",
     "husky": "^9.1.7",
     "jest": "^30.2.0",
@@ -73,13 +80,15 @@
     "prettier": "^3.6.2",
     "semantic-release": "^21.1.2",
     "ts-jest": "^29.4.5",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "secretlint": "11.2.5",
+    "@secretlint/secretlint-rule-preset-recommend": "11.2.5"
   },
   "peerDependencies": {
     "eslint": "^9.0.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18.18.0"
   },
   "overrides": {
     "glob": "12.0.0",