eslint-plugin-traceability 1.1.1 → 1.1.3

package/tests/plugin-default-export-and-configs.test.ts

@@ -1,50 +0,0 @@
-/**
- * Tests for: docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
- * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
- * @req REQ-PLUGIN-STRUCTURE - Validate plugin default export and configs in src/index.ts
- */
-import plugin, { rules, configs } from "../src/index";
-
-describe("Plugin Default Export and Configs (Story 001.0-DEV-PLUGIN-SETUP)", () => {
-  it("[REQ-PLUGIN-STRUCTURE] default export includes rules and configs", () => {
-    expect(plugin.rules).toBe(rules);
-    expect(plugin.configs).toBe(configs);
-  });
-
-  it("[REQ-PLUGIN-STRUCTURE] rules object has correct rule names", () => {
-    // Arrange: expected rule names in insertion order
-    const expected = [
-      "require-story-annotation",
-      "require-req-annotation",
-      "require-branch-annotation",
-      "valid-annotation-format",
-      "valid-story-reference",
-      "valid-req-reference",
-    ];
-    // Act: get actual rule names from plugin
-    const actual = Object.keys(rules);
-    // Assert: actual matches expected
-    expect(actual).toEqual(expected);
-  });
-
-  it("[REQ-RULE-REGISTRY] configs.recommended contains correct rule configuration", () => {
-    const recommendedRules = configs.recommended[0].rules;
-    expect(recommendedRules).toHaveProperty(
-      "traceability/require-story-annotation",
-      "error",
-    );
-    expect(recommendedRules).toHaveProperty(
-      "traceability/require-req-annotation",
-      "error",
-    );
-    expect(recommendedRules).toHaveProperty(
-      "traceability/require-branch-annotation",
-      "error",
-    );
-  });
-
-  it("[REQ-CONFIG-SYSTEM] configs.strict contains same rules as recommended", () => {
-    const strictRules = configs.strict[0].rules;
-    expect(strictRules).toEqual(configs.recommended[0].rules);
-  });
-});

package/tests/plugin-setup.test.ts

@@ -1,17 +0,0 @@
-/**
- * Tests for: docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
- * @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
- * @req REQ-PLUGIN-STRUCTURE - plugin exports rules and configs
- */
-import plugin, { rules, configs } from "../src/index";
-
-describe("Traceability ESLint Plugin (Story 001.0-DEV-PLUGIN-SETUP)", () => {
-  it("[REQ-PLUGIN-STRUCTURE] plugin exports rules and configs", () => {
-    expect(rules).toBeDefined();
-    expect(configs).toBeDefined();
-    expect(typeof rules).toBe("object");
-    expect(typeof configs).toBe("object");
-    expect(plugin.rules).toBe(rules);
-    expect(plugin.configs).toBe(configs);
-  });
-});

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

@@ -1,250 +0,0 @@
-/**
- * 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";
-
-const ruleTester = new RuleTester({
-  languageOptions: { parserOptions: { ecmaVersion: 2020 } },
-} as any);
-
-describe("Require Branch Annotation Rule (Story 004.0-DEV-BRANCH-ANNOTATIONS)", () => {
-  ruleTester.run("require-branch-annotation", rule, {
-    valid: [
-      {
-        name: "[REQ-BRANCH-DETECTION] valid fallback scanning comment detection",
-        code: `switch (value) {
-
-  // @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-  // @req REQ-BRANCH-DETECTION
-  case 'z':
-    break;
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid if-statement with annotations",
-        code: `// @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-// @req REQ-BRANCH-DETECTION
-if (condition) {}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid for loop with block comment annotations",
-        code: `/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-for (let i = 0; i < 10; i++) {}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid switch-case with annotations",
-        code: `switch (value) {
-  // @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-  // @req REQ-BRANCH-DETECTION
-  case 'a':
-    break;
-  default:
-    break;
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid try-finally with annotations",
-        code: `/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-try {
-  doSomething();
-} finally {
-  cleanUp();
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid catch with annotations",
-        code: `/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-try {
-  doSomething();
-}
-/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-catch (error) {
-  handleError(error);
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid do-while loop with annotations",
-        code: `/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-do {
-  process();
-} while (condition);`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid for-of loop with annotations",
-        code: `/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-for (const item of items) {
-  process(item);
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid for-in loop with annotations",
-        code: `/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-for (const key in object) {
-  console.log(key);
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid while loop with annotations",
-        code: `/* @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md */
-/* @req REQ-BRANCH-DETECTION */
-while (condition) {
-  iterate();
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid switch-case with inline annotation",
-        code: `switch (value) {
-  // @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-  // @req REQ-BRANCH-DETECTION
-  case 'a':
-    break;
-}`,
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] valid default case without annotations",
-        code: `switch (value) {
-  default:
-    doSomething();
-}`,
-      },
-    ],
-    invalid: [
-      {
-        name: "[REQ-BRANCH-DETECTION] missing annotations on if-statement",
-        code: `if (condition) {}`,
-        output: `// @story <story-file>.story.md
-if (condition) {}`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-        ],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing @req on for loop when only story present",
-        code: `// @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-for (let i = 0; i < 5; i++) {}`,
-        output: `// @story docs/stories/004.0-DEV-BRANCH-ANNOTATIONS.story.md
-// @req <REQ-ID>
-for (let i = 0; i < 5; i++) {}`,
-        errors: [{ messageId: "missingAnnotation", data: { missing: "@req" } }],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing @story on while loop when only req present",
-        code: `// @req REQ-BRANCH-DETECTION
-while (true) {}`,
-        output: `// @req REQ-BRANCH-DETECTION
-// @story <story-file>.story.md
-while (true) {}`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-        ],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing annotations on switch-case",
-        code: `switch (value) {
-  case 'a':
-    break;
-}`,
-        output: `switch (value) {
-  // @story <story-file>.story.md
-  case 'a':
-    break;
-}`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-        ],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing annotations on do-while loop",
-        code: `do {
-  action();
-} while (condition);`,
-        output: `// @story <story-file>.story.md
-do {
-  action();
-} while (condition);`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-        ],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing annotations on for-of loop",
-        code: `for (const item of items) {
-  process(item);
-}`,
-        output: `// @story <story-file>.story.md
-for (const item of items) {
-  process(item);
-}`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-        ],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing annotations on for-in loop",
-        code: `for (const key in object) {
-  console.log(key);
-}`,
-        output: `// @story <story-file>.story.md
-for (const key in object) {
-  console.log(key);
-}`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-        ],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing annotations on try-catch blocks",
-        code: `try {
-  doSomething();
-} catch (error) {
-  handleError(error);
-}`,
-        output: `// @story <story-file>.story.md
-try {
-  doSomething();
-} catch (error) {
-  handleError(error);
-}`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-        ],
-      },
-      {
-        name: "[REQ-BRANCH-DETECTION] missing annotations on switch-case with blank line",
-        code: `switch (value) {
-
-  case 'a':
-    break;
-}`,
-        output: `switch (value) {
-
-  // @story <story-file>.story.md
-  case 'a':
-    break;
-}`,
-        errors: [
-          { messageId: "missingAnnotation", data: { missing: "@story" } },
-          { messageId: "missingAnnotation", data: { missing: "@req" } },
-        ],
-      },
-    ],
-  });
-});

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

@@ -1,38 +0,0 @@
-/**
- * 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-req-annotation rule enforces @req on functions
- */
-import { RuleTester } from "eslint";
-import rule from "../../src/rules/require-req-annotation";
-
-const ruleTester = new RuleTester();
-
-describe("Require Req Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", () => {
-  ruleTester.run("require-req-annotation", rule, {
-    valid: [
-      {
-        name: "[REQ-ANNOTATION-REQUIRED] valid with only @req annotation",
-        code: `/**\n * @req REQ-EXAMPLE\n */\nfunction foo() {}`,
-      },
-      {
-        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() {}`,
-      },
-    ],
-    invalid: [
-      {
-        name: "[REQ-ANNOTATION-REQUIRED] missing @req on function without JSDoc",
-        code: `function baz() {}`,
-        output: `/** @req <REQ-ID> */\nfunction baz() {}`,
-        errors: [{ messageId: "missingReq" }],
-      },
-      {
-        name: "[REQ-ANNOTATION-REQUIRED] missing @req on function with only @story annotation",
-        code: `/**\n * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md\n */\nfunction qux() {}`,
-        output: `/**\n * @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md\n */\n/** @req <REQ-ID> */\nfunction qux() {}`,
-        errors: [{ messageId: "missingReq" }],
-      },
-    ],
-  });
-});

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

@@ -1,33 +0,0 @@
-/**
- * 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";
-
-const ruleTester = new RuleTester();
-
-describe("Require Story Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", () => {
-  ruleTester.run("require-story-annotation", rule, {
-    valid: [
-      {
-        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-ANNOTATION-REQUIRED] valid with line comment @story annotation",
-        code: `// @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md
-function foo() {}`,
-      },
-    ],
-    invalid: [
-      {
-        name: "[REQ-ANNOTATION-REQUIRED] missing @story annotation on function",
-        code: `function bar() {}`,
-        output: `/** @story <story-file>.story.md */\nfunction bar() {}`,
-        errors: [{ messageId: "missingStory" }],
-      },
-    ],
-  });
-});

package/tests/rules/valid-annotation-format.test.ts

@@ -1,55 +0,0 @@
-/**
- * Tests for: docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
- * @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
- * @req REQ-FORMAT-SPECIFICATION - Verify valid-annotation-format rule enforces annotation format syntax
- */
-import { RuleTester } from "eslint";
-import rule from "../../src/rules/valid-annotation-format";
-
-const ruleTester = new RuleTester({
-  languageOptions: { parserOptions: { ecmaVersion: 2020 } },
-} as any);
-
-describe("Valid Annotation Format Rule (Story 005.0-DEV-ANNOTATION-VALIDATION)", () => {
-  ruleTester.run("valid-annotation-format", rule, {
-    valid: [
-      {
-        name: "[REQ-PATH-FORMAT] valid story annotation format",
-        code: `// @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md`,
-      },
-      {
-        name: "[REQ-REQ-FORMAT] valid req annotation format",
-        code: `// @req REQ-EXAMPLE`,
-      },
-      {
-        name: "[REQ-FORMAT-SPECIFICATION] valid block annotations",
-        code: `/**
- * @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story.md
- * @req REQ-VALID-EXAMPLE
- */`,
-      },
-    ],
-    invalid: [
-      {
-        name: "[REQ-PATH-FORMAT] missing story path",
-        code: `// @story`,
-        errors: [{ messageId: "invalidStoryFormat" }],
-      },
-      {
-        name: "[REQ-PATH-FORMAT] invalid story file extension",
-        code: `// @story docs/stories/005.0-DEV-ANNOTATION-VALIDATION.story`,
-        errors: [{ messageId: "invalidStoryFormat" }],
-      },
-      {
-        name: "[REQ-REQ-FORMAT] missing req id",
-        code: `// @req`,
-        errors: [{ messageId: "invalidReqFormat" }],
-      },
-      {
-        name: "[REQ-REQ-FORMAT] invalid req id format",
-        code: `// @req invalid-format`,
-        errors: [{ messageId: "invalidReqFormat" }],
-      },
-    ],
-  });
-});

package/tests/rules/valid-req-reference.test.ts

@@ -1,85 +0,0 @@
-/**
- * Tests for: docs/stories/010.0-DEV-DEEP-VALIDATION.story.md
- * @story docs/stories/010.0-DEV-DEEP-VALIDATION.story.md
- * @req REQ-DEEP-PARSE - Verify valid-req-reference rule enforces existing requirement content
- */
-import { RuleTester } from "eslint";
-import rule from "../../src/rules/valid-req-reference";
-
-const ruleTester = new RuleTester({
-  languageOptions: { parserOptions: { ecmaVersion: 2020 } },
-} as any);
-
-describe("Valid Req Reference Rule (Story 010.0-DEV-DEEP-VALIDATION)", () => {
-  ruleTester.run("valid-req-reference", rule, {
-    valid: [
-      {
-        name: "[REQ-DEEP-PARSE] valid requirement reference existing in story file",
-        code: `// @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
-// @req REQ-PLUGIN-STRUCTURE`,
-      },
-      {
-        name: "[REQ-DEEP-BULLET] valid bullet list requirement existing in bullet story fixture",
-        code: `// @story tests/fixtures/story_bullet.md
-// @req REQ-BULLET-LIST`,
-      },
-    ],
-    invalid: [
-      {
-        name: "[REQ-DEEP-MATCH] missing requirement in story file",
-        code: `// @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
-// @req REQ-NON-EXISTENT`,
-        errors: [
-          {
-            messageId: "reqMissing",
-            data: {
-              reqId: "REQ-NON-EXISTENT",
-              storyPath: "docs/stories/001.0-DEV-PLUGIN-SETUP.story.md",
-            },
-          },
-        ],
-      },
-      {
-        name: "[REQ-DEEP-PARSE] disallow path traversal in story path",
-        code: `// @story ../docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
-// @req REQ-PLUGIN-STRUCTURE`,
-        errors: [
-          {
-            messageId: "invalidPath",
-            data: {
-              storyPath: "../docs/stories/001.0-DEV-PLUGIN-SETUP.story.md",
-            },
-          },
-        ],
-      },
-      {
-        name: "[REQ-DEEP-PARSE] disallow absolute path in story path",
-        code: `// @story /absolute/path/docs/stories/001.0-DEV-PLUGIN-SETUP.story.md
-// @req REQ-PLUGIN-STRUCTURE`,
-        errors: [
-          {
-            messageId: "invalidPath",
-            data: {
-              storyPath:
-                "/absolute/path/docs/stories/001.0-DEV-PLUGIN-SETUP.story.md",
-            },
-          },
-        ],
-      },
-      {
-        name: "[REQ-DEEP-BULLET] missing bullet list requirement in bullet story fixture",
-        code: `// @story tests/fixtures/story_bullet.md
-// @req REQ-MISSING-BULLET`,
-        errors: [
-          {
-            messageId: "reqMissing",
-            data: {
-              reqId: "REQ-MISSING-BULLET",
-              storyPath: "tests/fixtures/story_bullet.md",
-            },
-          },
-        ],
-      },
-    ],
-  });
-});

package/tests/rules/valid-story-reference.test.ts

@@ -1,66 +0,0 @@
-/**
- * Tests for: docs/stories/006.0-DEV-FILE-VALIDATION.story.md
- * @story docs/stories/006.0-DEV-FILE-VALIDATION.story.md
- * @req REQ-FILE-EXISTENCE - Verify valid-story-reference rule enforces existing .story.md files
- */
-import { RuleTester } from "eslint";
-import rule from "../../src/rules/valid-story-reference";
-
-const ruleTester = new RuleTester({
-  languageOptions: { parserOptions: { ecmaVersion: 2020 } },
-} as any);
-
-describe("Valid Story Reference Rule (Story 006.0-DEV-FILE-VALIDATION)", () => {
-  ruleTester.run("valid-story-reference", rule, {
-    valid: [
-      {
-        name: "[REQ-FILE-EXISTENCE] valid story file reference",
-        code: `// @story docs/stories/001.0-DEV-PLUGIN-SETUP.story.md`,
-      },
-      {
-        name: "[REQ-EXTENSION] valid .story.md extension",
-        code: `// @story docs/stories/002.0-DEV-ESLINT-CONFIG.story.md`,
-      },
-      {
-        name: "[REQ-PATH-RESOLUTION] valid relative path with ./ prefix",
-        code: `// @story ./docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md`,
-      },
-    ],
-    invalid: [
-      {
-        name: "[REQ-PATH-RESOLUTION] missing file",
-        code: `// @story docs/stories/missing-file.story.md`,
-        errors: [
-          {
-            messageId: "fileMissing",
-            data: { path: "docs/stories/missing-file.story.md" },
-          },
-        ],
-      },
-      {
-        name: "[REQ-EXTENSION] invalid extension",
-        code: `// @story docs/stories/001.0-DEV-PLUGIN-SETUP.md`,
-        errors: [
-          {
-            messageId: "invalidExtension",
-            data: { path: "docs/stories/001.0-DEV-PLUGIN-SETUP.md" },
-          },
-        ],
-      },
-      {
-        name: "[REQ-PATH-SECURITY] path traversal",
-        code: `// @story ../outside.story.md`,
-        errors: [
-          { messageId: "invalidPath", data: { path: "../outside.story.md" } },
-        ],
-      },
-      {
-        name: "[REQ-ABSOLUTE-PATH] absolute path not allowed",
-        code: `// @story /etc/passwd.story.md`,
-        errors: [
-          { messageId: "invalidPath", data: { path: "/etc/passwd.story.md" } },
-        ],
-      },
-    ],
-  });
-});

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "moduleResolution": "node",
-    "declaration": true,
-    "outDir": "lib",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "types": ["node", "jest", "eslint", "@typescript-eslint/utils"]
-  },
-  "include": ["src", "tests"]
-}