eslint-plugin-traceability 1.0.6 → 1.1.1

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

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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
+ */
+const eslint_1 = require("eslint");
+const valid_annotation_format_1 = __importDefault(require("../../src/rules/valid-annotation-format"));
+const ruleTester = new eslint_1.RuleTester({
+    languageOptions: { parserOptions: { ecmaVersion: 2020 } },
+});
+describe("Valid Annotation Format Rule (Story 005.0-DEV-ANNOTATION-VALIDATION)", () => {
+    ruleTester.run("valid-annotation-format", valid_annotation_format_1.default, {
+        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/lib/tests/rules/valid-req-reference.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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
+ */
+const eslint_1 = require("eslint");
+const valid_req_reference_1 = __importDefault(require("../../src/rules/valid-req-reference"));
+const ruleTester = new eslint_1.RuleTester({
+    languageOptions: { parserOptions: { ecmaVersion: 2020 } },
+});
+describe("Valid Req Reference Rule (Story 010.0-DEV-DEEP-VALIDATION)", () => {
+    ruleTester.run("valid-req-reference", valid_req_reference_1.default, {
+        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/lib/tests/rules/valid-story-reference.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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
+ */
+const eslint_1 = require("eslint");
+const valid_story_reference_1 = __importDefault(require("../../src/rules/valid-story-reference"));
+const ruleTester = new eslint_1.RuleTester({
+    languageOptions: { parserOptions: { ecmaVersion: 2020 } },
+});
+describe("Valid Story Reference Rule (Story 006.0-DEV-FILE-VALIDATION)", () => {
+    ruleTester.run("valid-story-reference", valid_story_reference_1.default, {
+        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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-traceability",
-  "version": "1.0.6",
+  "version": "1.1.1",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -16,6 +16,7 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "duplication": "jscpd src tests --reporters console --threshold 3",
+    "smoke-test": "./scripts/smoke-test.sh",
     "prepare": "husky install"
   },
   "lint-staged": {

package/scripts/smoke-test.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+set -e
+
+echo "🧪 Running smoke test for eslint-plugin-traceability"
+echo ""
+
+# Pack the package first
+echo "📦 Packing the package..."
+tarball=$(npm pack 2>&1 | tail -1)
+echo "   Created: $tarball"
+
+# Create temporary directory
+workdir=$(mktemp -d)
+echo "📁 Created test directory: $workdir"
+
+# Cleanup on exit
+cleanup() {
+  echo "🧹 Cleaning up test directory and tarball"
+  rm -rf "$workdir"
+  rm -f "$tarball"
+}
+trap cleanup EXIT
+
+cd "$workdir"
+
+# Initialize npm project
+echo "📦 Initializing npm project..."
+npm init -y > /dev/null
+
+# Install the packed tarball
+echo "📥 Installing eslint-plugin-traceability from packed tarball..."
+npm install "$OLDPWD/$tarball" > /dev/null
+
+# Create ESLint config (CommonJS format)
+echo "⚙️  Creating ESLint config..."
+cat > eslint.config.js << 'EOF'
+const traceability = require('eslint-plugin-traceability');
+module.exports = [
+  {
+    plugins: { traceability },
+    rules: {}
+  }
+];
+EOF
+
+# Test the plugin loads
+echo "🔍 Testing plugin configuration..."
+npx eslint --print-config eslint.config.js > /dev/null
+
+echo ""
+echo "✅ Smoke test passed! Plugin loads successfully."