eslint-plugin-traceability 1.6.0 → 1.6.2

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

@@ -44,25 +44,96 @@ describe("Require Req Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", (
                     parserOptions: { ecmaVersion: 2022, sourceType: "module" },
                 },
             },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] valid FunctionExpression with @req annotation",
+                code: `const fn = /**\n * @req REQ-EXAMPLE\n */\nfunction() {};`,
+            },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] valid MethodDefinition with @req annotation",
+                code: `class C {\n  /**\n   * @req REQ-EXAMPLE\n   */\n  m() {}\n}`,
+            },
+            {
+                name: "[REQ-TYPESCRIPT-SUPPORT][REQ-FUNCTION-DETECTION][Story 003.0] valid TS FunctionExpression in variable declarator with @req",
+                code: `const fn = /**\n * @req REQ-EXAMPLE\n */\nfunction () {};`,
+                languageOptions: {
+                    parser: require("@typescript-eslint/parser"),
+                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+                },
+            },
+            {
+                name: "[REQ-TYPESCRIPT-SUPPORT][REQ-FUNCTION-DETECTION][Story 003.0] valid exported TS FunctionExpression in variable declarator with @req",
+                code: `export const fn = /**\n * @req REQ-EXAMPLE\n */\nfunction () {};`,
+                languageOptions: {
+                    parser: require("@typescript-eslint/parser"),
+                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+                },
+            },
+            {
+                name: "[REQ-CONFIGURABLE-SCOPE][Story 003.0] FunctionExpression ignored when scope only includes FunctionDeclaration",
+                code: `const fn = function () {};`,
+                options: [{ scope: ["FunctionDeclaration"] }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] non-exported function ignored when exportPriority is 'exported'",
+                code: `function nonExported() {}`,
+                options: [{ exportPriority: "exported" }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] exported function required when exportPriority is 'exported'",
+                code: `/** @req REQ-EXAMPLE */\nexport function exportedFn() {}`,
+                options: [{ exportPriority: "exported" }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] exported function ignored when exportPriority is 'non-exported'",
+                code: `export function exportedFn() {}`,
+                options: [{ exportPriority: "non-exported" }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] non-exported function required when exportPriority is 'non-exported'",
+                code: `/** @req REQ-EXAMPLE */\nfunction nonExported() {}`,
+                options: [{ exportPriority: "non-exported" }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] exported method ignored when exportPriority is 'non-exported'",
+                code: `export class C {\n  m() {}\n}`,
+                options: [{ exportPriority: "non-exported" }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] non-exported method required when exportPriority is 'non-exported'",
+                code: `class C {\n  /** @req REQ-EXAMPLE */\n  m() {}\n}`,
+                options: [{ exportPriority: "non-exported" }],
+            },
         ],
         invalid: [
             {
                 name: "[REQ-ANNOTATION-REQUIRED] missing @req on function without JSDoc",
                 code: `function baz() {}`,
-                output: `/** @req <REQ-ID> */\nfunction baz() {}`,
-                errors: [{ messageId: "missingReq", data: { name: "baz" } }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "baz", functionName: "baz" },
+                    },
+                ],
             },
             {
                 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", data: { name: "qux" } }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "qux", functionName: "qux" },
+                    },
+                ],
             },
             {
                 name: "[REQ-TYPESCRIPT-SUPPORT] missing @req on TSDeclareFunction",
                 code: `declare function baz(): void;`,
-                output: `/** @req <REQ-ID> */\ndeclare function baz(): void;`,
-                errors: [{ messageId: "missingReq", data: { name: "baz" } }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "baz", functionName: "baz" },
+                    },
+                ],
                 languageOptions: {
                     parser: require("@typescript-eslint/parser"),
                     parserOptions: { ecmaVersion: 2022, sourceType: "module" },
@@ -71,13 +142,162 @@ describe("Require Req Annotation Rule (Story 003.0-DEV-FUNCTION-ANNOTATIONS)", (
             {
                 name: "[REQ-TYPESCRIPT-SUPPORT] missing @req on TSMethodSignature",
                 code: `interface I { method(): void; }`,
-                output: `interface I { /** @req <REQ-ID> */\nmethod(): void; }`,
-                errors: [{ messageId: "missingReq", data: { name: "method" } }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "method", functionName: "method" },
+                    },
+                ],
+                languageOptions: {
+                    parser: require("@typescript-eslint/parser"),
+                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+                },
+            },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] missing @req on FunctionExpression assigned to variable",
+                code: `const fn = function () {};`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "fn", functionName: "fn" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] missing @req on anonymous FunctionExpression (no variable name)",
+                code: `(function () {})();`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "(anonymous)", functionName: "(anonymous)" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] missing @req on MethodDefinition in class",
+                code: `class C {\n  m() {}\n}`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "m", functionName: "m" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-FUNCTION-DETECTION][Story 003.0] missing @req on MethodDefinition in object literal",
+                code: `const o = { m() {} };`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "m", functionName: "m" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-TYPESCRIPT-SUPPORT][REQ-FUNCTION-DETECTION][Story 003.0] missing @req on TS FunctionExpression in variable declarator",
+                code: `const fn = function () {};`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "fn", functionName: "fn" },
+                    },
+                ],
+                languageOptions: {
+                    parser: require("@typescript-eslint/parser"),
+                    parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+                },
+            },
+            {
+                name: "[REQ-TYPESCRIPT-SUPPORT][REQ-FUNCTION-DETECTION][Story 003.0] missing @req on exported TS FunctionExpression in variable declarator",
+                code: `export const fn = function () {};`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "fn", functionName: "fn" },
+                    },
+                ],
                 languageOptions: {
                     parser: require("@typescript-eslint/parser"),
                     parserOptions: { ecmaVersion: 2022, sourceType: "module" },
                 },
             },
+            {
+                name: "[REQ-CONFIGURABLE-SCOPE][Story 003.0] FunctionDeclaration still reported when scope only includes FunctionDeclaration",
+                code: `function scoped() {}`,
+                options: [{ scope: ["FunctionDeclaration"] }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "scoped", functionName: "scoped" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] exported function reported when exportPriority is 'exported'",
+                code: `export function exportedFn() {}`,
+                options: [{ exportPriority: "exported" }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "exportedFn", functionName: "exportedFn" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] non-exported function reported when exportPriority is 'non-exported'",
+                code: `function nonExported() {}`,
+                options: [{ exportPriority: "non-exported" }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "nonExported", functionName: "nonExported" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] exported method reported when exportPriority is 'exported'",
+                code: `export class C {\n  m() {}\n}`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "m", functionName: "m" },
+                    },
+                ],
+                options: [{ exportPriority: "exported" }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] non-exported method reported when exportPriority is 'non-exported'",
+                code: `class C {\n  m() {}\n}`,
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "m", functionName: "m" },
+                    },
+                ],
+                options: [{ exportPriority: "non-exported" }],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] exported FunctionExpression reported when exportPriority is 'exported'",
+                code: `export const fn = function () {};`,
+                options: [{ exportPriority: "exported" }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "fn", functionName: "fn" },
+                    },
+                ],
+            },
+            {
+                name: "[REQ-EXPORT-PRIORITY][Story 003.0] non-exported FunctionExpression reported when exportPriority is 'non-exported'",
+                code: `const fn = function () {};`,
+                options: [{ exportPriority: "non-exported" }],
+                errors: [
+                    {
+                        messageId: "missingReq",
+                        data: { name: "fn", functionName: "fn" },
+                    },
+                ],
+            },
         ],
     });
 });

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

@@ -105,6 +105,7 @@ declare function tsDecl(): void;`,
                 errors: [
                     {
                         messageId: "missingStory",
+                        data: { name: "method", functionName: "method" },
                         suggestions: [
                             {
                                 desc: `Add JSDoc @story annotation for function 'method', e.g., /** @story docs/stories/003.0-DEV-FUNCTION-ANNOTATIONS.story.md */`,

package/lib/tests/rules/valid-annotation-format.test.js

@@ -7,6 +7,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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
+ * Tests for: docs/stories/007.0-DEV-ERROR-REPORTING.story.md
+ * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
+ * @req REQ-ERROR-MESSAGES-CONSISTENT - Verify invalid annotation errors use consistent wording and structure
+ * @req REQ-ERROR-MESSAGES-ACTIONABLE - Verify invalid annotation errors provide actionable guidance and examples
+ * @req REQ-ERROR-MESSAGES-IDENTIFIERS - Verify invalid annotation errors echo the offending identifier/path in the message
  */
 const eslint_1 = require("eslint");
 const valid_annotation_format_1 = __importDefault(require("../../src/rules/valid-annotation-format"));

package/lib/tests/rules/valid-req-reference.test.js

@@ -7,6 +7,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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
+ *
+ * Additional coverage for error reporting behavior:
+ * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
+ * @req REQ-ERROR-SPECIFIC - Verify requirement-level errors identify the exact missing requirement
+ * @req REQ-ERROR-CONTEXT - Verify requirement-level errors include relevant story path context
+ * @req REQ-ERROR-CONSISTENCY - Verify requirement-level error messages are consistent across cases
  */
 const eslint_1 = require("eslint");
 const valid_req_reference_1 = __importDefault(require("../../src/rules/valid-req-reference"));

package/lib/tests/rules/valid-story-reference.test.js

@@ -7,6 +7,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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
+ * @story docs/stories/007.0-DEV-ERROR-REPORTING.story.md
+ * @req REQ-ERROR-SPECIFIC - Verify file-related error messages are specific about failure causes
+ * @req REQ-ERROR-CONTEXT - Verify file-related error messages include contextual information (path, underlying error)
+ * @req REQ-ERROR-CONSISTENCY - Verify file-related error messages follow consistent formatting and identifiers
+ * @req REQ-ERROR-HANDLING - Verify file-related errors are reported via diagnostics instead of uncaught exceptions
  */
 const eslint_1 = require("eslint");
 const valid_story_reference_1 = __importDefault(require("../../src/rules/valid-story-reference"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "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",