playwright-cucumber-ts-steps 1.1.7 → 1.1.9

package/dist/core/registry.js

@@ -5,13 +5,22 @@ exports.Step = Step;
 // src/core/registry.ts
 const cucumber_expressions_1 = require("@cucumber/cucumber-expressions");
 // 2. The Global Registry
-// This array stores every step you create in the backend folder
 exports.stepRegistry = [];
 const parameterTypeRegistry = new cucumber_expressions_1.ParameterTypeRegistry();
-// 3. The Function to Register Steps
-// You will use this inside src/backend/actions/...
+/**
+ * 3. The Function to Register Steps
+ * Supports passing a string (converted to CucumberExpression) OR a direct RegExp.
+ */
 function Step(pattern, fn) {
-    const expression = new cucumber_expressions_1.CucumberExpression(pattern, parameterTypeRegistry);
+    let expression;
+    if (pattern instanceof RegExp) {
+        // ✅ If it's a Regex, use it directly (Faster, Standard)
+        expression = pattern;
+    }
+    else {
+        // ⚠️ If it's a String, convert to Cucumber Expression (Legacy)
+        expression = new cucumber_expressions_1.CucumberExpression(pattern, parameterTypeRegistry);
+    }
     exports.stepRegistry.push({
         expression,
         fn,

package/dist/core/runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/core/runner.ts"],"names":[],"mappings":"AAMA,OAAO,0BAA0B,CAAC;AAClC,OAAO,6BAA6B,CAAC;AACrC,OAAO,2BAA2B,CAAC;AACnC,OAAO,sBAAsB,CAAC;AAC9B,OAAO,uBAAuB,CAAC;AAE/B,OAAO,qBAAqB,CAAC;AAE7B,UAAU,aAAa;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC3C;AAED,wBAAgB,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,QAyIpE"}
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/core/runner.ts"],"names":[],"mappings":"AAMA,OAAO,0BAA0B,CAAC;AAClC,OAAO,6BAA6B,CAAC;AACrC,OAAO,2BAA2B,CAAC;AACnC,OAAO,sBAAsB,CAAC;AAC9B,OAAO,uBAAuB,CAAC;AAE/B,OAAO,qBAAqB,CAAC;AAE7B,UAAU,aAAa;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC3C;AASD,wBAAgB,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,QA4LpE"}

package/dist/core/runner.js

@@ -34,8 +34,8 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runTests = runTests;
-const test_1 = require("@playwright/test");
 const fs = __importStar(require("fs"));
+const test_1 = require("@playwright/test");
 const glob_1 = require("glob");
 const registry_1 = require("./registry");
 // LOAD BACKEND LIBRARIES
@@ -58,7 +58,6 @@ function runTests(featureGlob, options) {
     for (const file of files) {
         const content = fs.readFileSync(file, "utf8");
         // 1. CAPTURE FEATURE TAGS
-        // Loose Regex: Matches any lines starting with @ above "Feature:"
         const featureTagMatch = content.match(/((?:@\S+\s*)+)Feature:/);
         const rawFeatureTags = featureTagMatch ? featureTagMatch[1] : "";
         const featureTags = rawFeatureTags.replace(/[\r\n]+/g, " ").trim();
@@ -67,9 +66,8 @@ function runTests(featureGlob, options) {
             ? featureMatch[1].trim()
             : "Unnamed Feature";
         test_1.test.describe(featureName, () => {
-            // 2. LOOSE SCENARIO REGEX
+            // 2. SCENARIO REGEX
             // Matches: Optional Tags -> (Scenario OR Scenario Outline) -> Name
-            // Change: @\S+ allows dots/dashes. "Scenario|Scenario Outline" supports outlines.
             const scenarioRegex = /(?:((?:@\S+\s*)+))?(?:Scenario|Scenario Outline):\s*(.+)/g;
             let match;
             let foundCount = 0;
@@ -83,9 +81,7 @@ function runTests(featureGlob, options) {
                 const fullName = combinedTags
                     ? `${scenarioName} ${combinedTags}`
                     : scenarioName;
-                // DEBUG LOG: See what we found
-                // console.log(`   👉 Found: "${scenarioName}" [Tags: ${combinedTags}]`);
-                // 4. ENV FILTERING (Optional)
+                // 4. ENV FILTERING
                 const activeFilter = options?.tags || envTag;
                 if (activeFilter) {
                     const targetGroups = activeFilter.split(",").map((t) => t.trim());
@@ -96,6 +92,7 @@ function runTests(featureGlob, options) {
                     if (!isMatch)
                         continue;
                 }
+                // 5. EXTRACT SCENARIO BLOCK
                 const startIndex = match.index + match[0].length;
                 const nextMatchIndex = content
                     .slice(startIndex)
@@ -103,43 +100,90 @@ function runTests(featureGlob, options) {
                 const blockEnd = nextMatchIndex === -1 ? content.length : startIndex + nextMatchIndex;
                 const scenarioBlock = content.slice(startIndex, blockEnd);
                 (0, test_1.test)(fullName, async ({ page }, testInfo) => {
-                    const lines = scenarioBlock
-                        .trim()
-                        .split("\n")
-                        .map((l) => l.trim())
-                        .filter((l) => l);
-                    for (let i = 0; i < lines.length; i++) {
-                        const stepText = lines[i];
-                        if (stepText.startsWith("#") ||
-                            stepText.startsWith("@") ||
-                            stepText === "")
+                    // ==================================================
+                    // PHASE 1: PARSE GHERKIN (Preserve Formatting)
+                    // ==================================================
+                    const rawLines = scenarioBlock.split("\n");
+                    const steps = [];
+                    let currentStep = null;
+                    let docStringBuffer = [];
+                    let isDocStringOpen = false;
+                    for (let line of rawLines) {
+                        const trimmedLine = line.trim();
+                        // A. Handle DocStrings (""")
+                        if (trimmedLine.startsWith('"""')) {
+                            isDocStringOpen = !isDocStringOpen;
+                            if (!isDocStringOpen && currentStep) {
+                                // Closing DocString: Save buffer to step
+                                currentStep.docString = docStringBuffer.join("\n");
+                                docStringBuffer = [];
+                            }
+                            continue;
+                        }
+                        // B. Inside DocString? Capture raw line (preserve indent)
+                        if (isDocStringOpen) {
+                            docStringBuffer.push(line); // Don't trim!
+                            continue;
+                        }
+                        // C. Skip Empty Lines & Comments
+                        if (!trimmedLine ||
+                            trimmedLine.startsWith("#") ||
+                            trimmedLine.startsWith("@")) {
                             continue;
-                        // Handle Data Tables
-                        const tableData = [];
-                        while (i + 1 < lines.length && lines[i + 1].startsWith("|")) {
-                            i++;
-                            const row = lines[i]
-                                .split("|")
-                                .map((cell) => cell.trim())
-                                .filter((cell) => cell !== "");
-                            tableData.push(row);
                         }
-                        const cleanStep = stepText
+                        // D. Handle Data Tables (| col | col |)
+                        if (trimmedLine.startsWith("|")) {
+                            if (currentStep) {
+                                if (!currentStep.dataTable)
+                                    currentStep.dataTable = [];
+                                const row = trimmedLine;
+                                const _row = trimmedLine.split("|").map((cell) => cell.trim())
+                                    .filter((cell, index, arr) => index > 0 && index < arr.length - 1);
+                                // Simple split often leaves empty strings at start/end
+                                // Better split logic:
+                                const cleanRow = trimmedLine
+                                    .split("|")
+                                    .slice(1, -1) // Remove first and last empty splits from |...|
+                                    .map((c) => c.trim());
+                                currentStep.dataTable.push(cleanRow);
+                            }
+                            continue;
+                        }
+                        // E. It is a New Step
+                        const cleanText = trimmedLine
                             .replace(/^(Given|When|Then|And|But)\s+/i, "")
-                            .replace(/:$/, "")
+                            .replace(/:$/, "") // Remove trailing colon
                             .trim();
-                        const matchResult = findMatchingStep(cleanStep);
+                        currentStep = {
+                            text: trimmedLine,
+                            cleanText: cleanText,
+                        };
+                        steps.push(currentStep);
+                    }
+                    // ==================================================
+                    // PHASE 2: EXECUTE STEPS
+                    // ==================================================
+                    console.log(`\n🔹 Scenario: ${scenarioName}`);
+                    for (const step of steps) {
+                        const matchResult = findMatchingStep(step.cleanText);
                         if (!matchResult) {
-                            throw new Error(`❌ Undefined Step: "${cleanStep}"`);
+                            throw new Error(`❌ Undefined Step: "${step.cleanText}"`);
                         }
                         try {
+                            console.log(`   executing: ${step.text.trim()}`);
                             const args = [...matchResult.args];
-                            if (tableData.length > 0)
-                                args.push(tableData);
+                            // Append Data Table if present
+                            if (step.dataTable && step.dataTable.length > 0) {
+                                args.push(step.dataTable);
+                            }
+                            // Append DocString if present
+                            if (step.docString) {
+                                args.push(step.docString);
+                            }
                             await matchResult.fn(page, ...args);
                         }
                         catch (error) {
-                            console.error(`❌ Failed at step: "${stepText}"`);
+                            console.error(`❌ Failed at step: "${step.text.trim()}"`);
                             const screenshot = await page.screenshot({
                                 fullPage: true,
                                 type: "png",
@@ -153,32 +197,41 @@ function runTests(featureGlob, options) {
                     }
                 });
             }
-            // SAFETY CHECK
             if (foundCount === 0) {
                 console.warn(`⚠️  File matched but 0 Scenarios found in: ${file}`);
-                console.warn(`   Check if you are using 'Scenario Outline' or strange spacing.`);
             }
         });
     }
 }
+/**
+ * Finds the matching step definition from the registry.
+ * Supports: RegExp (with capture groups) and CucumberExpressions.
+ */
 function findMatchingStep(text) {
     for (const step of registry_1.stepRegistry) {
+        // 1. RegExp Match
         if (step.expression instanceof RegExp) {
             const match = step.expression.exec(text);
-            if (match)
+            if (match) {
+                // match[0] is full string, slice(1) are capture groups
                 return { fn: step.fn, args: match.slice(1) };
+            }
         }
+        // 2. Cucumber Expression Match (if strictly typed)
         else if (typeof step.expression.match === "function") {
             const match = step.expression.match(text);
-            if (match)
+            if (match) {
                 return {
                     fn: step.fn,
                     args: match.map((arg) => arg.getValue(null)),
                 };
+            }
         }
+        // 3. String Match (Legacy/Simple)
         else if (typeof step.expression === "string") {
-            if (step.expression === text)
+            if (step.expression === text) {
                 return { fn: step.fn, args: [] };
+            }
         }
     }
     return null;

package/package.json

@@ -1,23 +1,40 @@
 {
   "name": "playwright-cucumber-ts-steps",
   "description": "A collection of reusable Playwright step definitions for Cucumber in TypeScript, designed to streamline end-to-end testing across web, API, and mobile applications.",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "private": false,
   "main": "dist/index.js",
+  "type": "module",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
   "scripts": {
     "build": "tsc",
     "docs": "typedoc",
-    "prepublishOnly": "npm run build"
+    "docs:deploy": "gh-pages -d temp-docs",
+    "prepublishOnly": "npm run build",
+    "prepare": "husky",
+    "playwright:ui": "npx playwright test --headed",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "lint:tsc": "tsc --noEmit",
+    "format": "prettier --write .",
+    "clean": "rm -rf playwright/report",
+    "test": "npx playwright test demoTest.spec.ts",
+    "commitlint": "commitlint --edit"
   },
-  "dependencies": {
-    "@cucumber/cucumber-expressions": "^17.1.0",
-    "@cucumber/gherkin": "^27.0.0",
-    "@cucumber/messages": "^22.0.0",
-    "glob": "^10.3.10"
+  "lint-staged": {
+    "*.{js,ts,tsx,json,md}": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/qaPaschalE/playwright-cucumber-ts-steps.git"
   },
   "keywords": [
     "playwright",
@@ -44,13 +61,36 @@
   },
   "homepage": "https://github.com/qaPaschalE/playwright-cucumber-ts-steps#readme",
   "peerDependencies": {
-    "@playwright/test": "^1.0.0"
+    "@playwright/test": "*"
   },
+  "files": [
+    "dist/"
+  ],
   "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@playwright/test": "^1.41.0",
     "@types/glob": "^8.1.0",
     "@types/node": "^20.11.0",
+    "@types/pngjs": "^6.0.5",
+    "@typescript-eslint/eslint-plugin": "^8.52.0",
+    "@typescript-eslint/parser": "^8.52.0",
+    "eslint": "^9.29.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-import": "^2.32.0",
+    "gh-pages": "^6.3.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.1.2",
+    "prettier": "^3.5.3",
+    "ts-node": "^10.9.2",
     "typedoc": "^0.28.15",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^8.34.1"
+  },
+  "dependencies": {
+    "@cucumber/cucumber-expressions": "^17.1.0",
+    "@cucumber/gherkin": "^27.0.0",
+    "@cucumber/messages": "^22.0.0",
+    "glob": "^10.3.10"
   }
 }