eslint-plugin-traceability 1.0.1 → 1.0.2

package/tests/integration/plugin-validation.test.ts

@@ -7,73 +7,78 @@
 import { spawnSync, SpawnSyncReturns } from "child_process";
 import path from "path";
 
+// Ensure ESLint CLI uses built plugin
 const eslintBin = path.resolve(__dirname, "../../node_modules/.bin/eslint");
 const configPath = path.resolve(__dirname, "../../eslint.config.js");
 
-function runEslint(code: string, rule: string): SpawnSyncReturns<string> {
-  const args = [
-    "--no-config-lookup",
-    "--config",
-    configPath,
-    "--stdin",
-    "--stdin-filename",
-    "foo.js",
-    "--rule",
-    "no-unused-vars:off",
-    "--rule",
-    rule,
-  ];
-  // Use Node to run the ESLint CLI script
-  return spawnSync("node", [eslintBin, ...args], {
-    encoding: "utf-8",
-    input: code,
+describe("ESLint CLI Integration (Story 001.0-DEV-PLUGIN-SETUP)", () => {
+  /**
+   * Helper to run ESLint CLI with the traceability plugin and custom rule
+   * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
+   * @req REQ-PLUGIN-STRUCTURE - Invoke ESLint CLI for integration testing
+   */
+  function runEslint(code: string, rule: string): SpawnSyncReturns<string> {
+    const args = [
+      "--no-config-lookup",
+      "--config",
+      configPath,
+      "--stdin",
+      "--stdin-filename",
+      "foo.js",
+      "--rule",
+      "no-unused-vars:off",
+      "--rule",
+      rule,
+    ];
+    return spawnSync("node", [eslintBin, ...args], {
+      encoding: "utf-8",
+      input: code,
+    });
+  }
+
+  it("[REQ-PLUGIN-STRUCTURE] reports error when @story annotation is missing", () => {
+    // Arrange
+    const code = "function foo() {}";
+    const rule = "traceability/require-story-annotation:error";
+    // Act
+    const result = runEslint(code, rule);
+    // Assert
+    expect(result.status).toBe(1);
+    expect(result.stdout).toMatch(/require-story-annotation/);
+  });
+
+  it("[REQ-PLUGIN-STRUCTURE] does not report error when @story annotation is present", () => {
+    // Arrange
+    const code = `/**
+ * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ */
+function foo() {}`;
+    const rule = "traceability/require-story-annotation:error";
+    // Act
+    const result = runEslint(code, rule);
+    // Assert
+    expect(result.status).toBe(0);
   });
-}
 
-const cliTests = [
-  {
-    name: "[REQ-PLUGIN-STRUCTURE] reports error when @story annotation is missing",
-    code: "function foo() {}",
-    rule: "traceability/require-story-annotation:error",
-    expectedStatus: 1,
-    stdoutRegex: /require-story-annotation/,
-  },
-  {
-    name: "does not report error when @story annotation is present",
-    code: `
-      /**
-       * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-       */
-      function foo() {}
-    `,
-    rule: "traceability/require-story-annotation:error",
-    expectedStatus: 0,
-  },
-  {
-    name: "Require Req Annotation CLI (Story 003.0-DEV-FUNCTION-ANNOTATIONS)",
-    code: "function foo() {}",
-    rule: "traceability/require-req-annotation:error",
-    expectedStatus: 1,
-    stdoutRegex: /require-req-annotation/,
-  },
-  {
-    name: "Require Branch Annotation CLI (Story 004.0-DEV-BRANCH-ANNOTATIONS)",
-    code: "if (condition) {}",
-    rule: "traceability/require-branch-annotation:error",
-    expectedStatus: 1,
-    stdoutRegex: /require-branch-annotation/,
-  },
-];
+  it("[REQ-REQ-CLI] reports error when @req annotation is missing", () => {
+    // Arrange
+    const code = "function foo() {}";
+    const rule = "traceability/require-req-annotation:error";
+    // Act
+    const result = runEslint(code, rule);
+    // Assert
+    expect(result.status).toBe(1);
+    expect(result.stdout).toMatch(/require-req-annotation/);
+  });
 
-describe("ESLint CLI Integration (Story 001.0-DEV-PLUGIN-SETUP)", () => {
-  test.each(cliTests)(
-    "$name",
-    ({ code, rule, expectedStatus, stdoutRegex }) => {
-      const result = runEslint(code, rule);
-      expect(result.status).toBe(expectedStatus);
-      if (stdoutRegex) {
-        expect(result.stdout).toMatch(stdoutRegex);
-      }
-    },
-  );
+  it("[REQ-BRANCH-CLI] reports error when branch annotations missing", () => {
+    // Arrange
+    const code = "if (true) {}";
+    const rule = "traceability/require-branch-annotation:error";
+    // Act
+    const result = runEslint(code, rule);
+    // Assert
+    expect(result.status).toBe(1);
+    expect(result.stdout).toMatch(/require-branch-annotation/);
+  });
 });

package/tests/maintenance/detect-isolated.test.ts

@@ -15,6 +15,7 @@ describe("detectStaleAnnotations isolated (Story 009.0-DEV-MAINTENANCE-TOOLS)",
   });
 
   it("[REQ-MAINT-DETECT] detects stale annotations in nested directories", () => {
+    // Arrange
     const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "tmp-nested-"));
     const nestedDir = path.join(tmpDir, "nested");
     fs.mkdirSync(nestedDir);
@@ -33,10 +34,13 @@ describe("detectStaleAnnotations isolated (Story 009.0-DEV-MAINTENANCE-TOOLS)",
 `;
     fs.writeFileSync(filePath2, content2, "utf8");
 
+    // Act
     const result = detectStaleAnnotations(tmpDir);
-    expect(result.sort()).toEqual(
-      ["stale1.story.md", "stale2.story.md"].sort(),
-    );
+
+    // Assert
+    expect(result).toHaveLength(2);
+    expect(result).toContain("stale1.story.md");
+    expect(result).toContain("stale2.story.md");
   });
 
   it("[REQ-MAINT-DETECT] throws error on permission denied", () => {

package/tests/rules/require-branch-annotation.test.ts

@@ -1,6 +1,8 @@
-// Tests for: docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-// @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-// @req REQ-BRANCH-DETECTION - Verify require-branch-annotation rule enforces branch annotations
+/**
+ * Tests for: docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+ * @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
+ * @req REQ-BRANCH-DETECTION - Verify require-branch-annotation rule enforces branch annotations
+ */
 import { RuleTester } from "eslint";
 import rule from "../../src/rules/require-branch-annotation";
 

package/tests/rules/require-story-annotation.test.ts

@@ -1,6 +1,7 @@
 /**
  * Tests for: docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
  * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
+ * @req REQ-ANNOTATION-REQUIRED - Verify require-story-annotation rule enforces @story annotation on functions
  */
 import { RuleTester } from "eslint";
 import rule from "../../src/rules/require-story-annotation";