@arghajit/playwright-pulse-report 0.2.10 → 0.3.0

package/README.md

@@ -84,6 +84,42 @@ npx generate-pulse-report  # Generates static HTML
 npx send-email            # Sends email report
 ```
 
+### 4. Custom Output Directory (Optional)
+
+All CLI scripts now support custom output directories, giving you full flexibility over where reports are generated:
+
+```bash
+# Using custom directory
+npx generate-pulse-report --outputDir my-reports
+npx generate-report -o test-results/e2e
+npx send-email --outputDir custom-pulse-reports
+
+# Using nested paths
+npx generate-pulse-report --outputDir reports/integration
+npx merge-pulse-report --outputDir my-test-reports
+```
+
+**Important:** Make sure your `playwright.config.ts` custom directory matches the CLI script:
+
+```typescript
+import { defineConfig } from "@playwright/test";
+import * as path from "path";
+
+const CUSTOM_REPORT_DIR = path.resolve(__dirname, "my-reports");
+
+export default defineConfig({
+  reporter: [
+    ["list"],
+    [
+      "@arghajit/playwright-pulse-report",
+      {
+        outputDir: CUSTOM_REPORT_DIR,  // Must match CLI --outputDir
+      },
+    ],
+  ],
+});
+```
+
 ## 📊 Report Options
 
 ### Option 1: Static HTML Report (Embedded Attachments)

package/dist/reporter/playwright-pulse-reporter.js

@@ -197,7 +197,7 @@ class PlaywrightPulseReporter {
         };
     }
     async onTestEnd(test, result) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
         const project = (_a = test.parent) === null || _a === void 0 ? void 0 : _a.project();
         const browserDetails = this.getBrowserDetails(test);
         const testStatus = convertStatus(result.status, test);
@@ -261,6 +261,7 @@ class PlaywrightPulseReporter {
             attachments: [],
             stdout: stdoutMessages.length > 0 ? stdoutMessages : undefined,
             stderr: stderrMessages.length > 0 ? stderrMessages : undefined,
+            annotations: ((_k = test.annotations) === null || _k === void 0 ? void 0 : _k.length) > 0 ? test.annotations : undefined,
             ...testSpecificData,
         };
         for (const [index, attachment] of result.attachments.entries()) {
@@ -277,16 +278,16 @@ class PlaywrightPulseReporter {
                 await this._ensureDirExists(path.dirname(absoluteDestPath));
                 await fs.copyFile(attachment.path, absoluteDestPath);
                 if (attachment.contentType.startsWith("image/")) {
-                    (_k = pulseResult.screenshots) === null || _k === void 0 ? void 0 : _k.push(relativeDestPath);
+                    (_l = pulseResult.screenshots) === null || _l === void 0 ? void 0 : _l.push(relativeDestPath);
                 }
                 else if (attachment.contentType.startsWith("video/")) {
-                    (_l = pulseResult.videoPath) === null || _l === void 0 ? void 0 : _l.push(relativeDestPath);
+                    (_m = pulseResult.videoPath) === null || _m === void 0 ? void 0 : _m.push(relativeDestPath);
                 }
                 else if (attachment.name === "trace") {
                     pulseResult.tracePath = relativeDestPath;
                 }
                 else {
-                    (_m = pulseResult.attachments) === null || _m === void 0 ? void 0 : _m.push({
+                    (_o = pulseResult.attachments) === null || _o === void 0 ? void 0 : _o.push({
                         name: attachment.name,
                         path: relativeDestPath,
                         contentType: attachment.contentType,

package/dist/types/index.d.ts

@@ -46,6 +46,15 @@ export interface TestResult {
     totalWorkers?: number;
     configFile?: string;
     metadata?: string;
+    annotations?: {
+        type: string;
+        description?: string;
+        location?: {
+            file: string;
+            line: number;
+            column: number;
+        };
+    }[];
 }
 export interface TestRun {
     id: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arghajit/playwright-pulse-report",
   "author": "Arghajit Singha",
-  "version": "0.2.10",
+  "version": "0.3.0",
   "description": "A Playwright reporter and dashboard for visualizing test results.",
   "homepage": "https://playwright-pulse-report.netlify.app/",
   "keywords": [
@@ -26,7 +26,7 @@
   "files": [
     "dist",
     "screenshots",
-    "scripts/generate-static-report.mjs"
+    "scripts"
   ],
   "license": "MIT",
   "bin": {

package/scripts/config-reader.mjs

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+import * as fs from "fs";
+import * as path from "path";
+import { pathToFileURL } from "url";
+import { dirname } from "path";
+
+const DEFAULT_OUTPUT_DIR = "pulse-report";
+
+async function findPlaywrightConfig() {
+  const possibleConfigs = [
+    "playwright.config.ts",
+    "playwright.config.js",
+    "playwright.config.mjs",
+  ];
+
+  for (const configFile of possibleConfigs) {
+    const configPath = path.resolve(process.cwd(), configFile);
+    if (fs.existsSync(configPath)) {
+      return { path: configPath, exists: true };
+    }
+  }
+
+  return { path: null, exists: false };
+}
+
+async function extractOutputDirFromConfig(configPath) {
+  try {
+    let config;
+
+    const configDir = dirname(configPath);
+    const originalDirname = global.__dirname;
+    const originalFilename = global.__filename;
+
+    try {
+      global.__dirname = configDir;
+      global.__filename = configPath;
+
+      if (configPath.endsWith(".ts")) {
+        try {
+          const { register } = await import("node:module");
+          const { pathToFileURL } = await import("node:url");
+
+          register("ts-node/esm", pathToFileURL("./"));
+
+          config = await import(pathToFileURL(configPath).href);
+        } catch (tsError) {
+          try {
+            const tsNode = await import("ts-node");
+            tsNode.register({
+              transpileOnly: true,
+              compilerOptions: {
+                module: "ESNext",
+              },
+            });
+            config = await import(pathToFileURL(configPath).href);
+          } catch (fallbackError) {
+            console.error("Failed to load TypeScript config:", fallbackError);
+            return null;
+          }
+        }
+      } else {
+        config = await import(pathToFileURL(configPath).href);
+      }
+    } finally {
+      if (originalDirname !== undefined) {
+        global.__dirname = originalDirname;
+      } else {
+        delete global.__dirname;
+      }
+      if (originalFilename !== undefined) {
+        global.__filename = originalFilename;
+      } else {
+        delete global.__filename;
+      }
+    }
+
+    const playwrightConfig = config.default || config;
+
+    if (playwrightConfig && Array.isArray(playwrightConfig.reporter)) {
+      for (const reporterConfig of playwrightConfig.reporter) {
+        if (Array.isArray(reporterConfig)) {
+          const [reporterPath, options] = reporterConfig;
+
+          if (
+            typeof reporterPath === "string" &&
+            (reporterPath.includes("playwright-pulse-report") ||
+              reporterPath.includes("@arghajit/playwright-pulse-report") ||
+              reporterPath.includes("@arghajit/dummy"))
+          ) {
+            if (options && options.outputDir) {
+              const resolvedPath =
+                typeof options.outputDir === "string"
+                  ? options.outputDir
+                  : options.outputDir;
+              console.log(`Found outputDir in config: ${resolvedPath}`);
+              return path.resolve(process.cwd(), resolvedPath);
+            }
+          }
+        }
+      }
+    }
+
+    console.log("No matching reporter config found with outputDir");
+    return null;
+  } catch (error) {
+    console.error("Error extracting outputDir from config:", error);
+    return null;
+  }
+}
+
+export async function getOutputDir(customOutputDirFromArgs = null) {
+  if (customOutputDirFromArgs) {
+    console.log(`Using custom outputDir from CLI: ${customOutputDirFromArgs}`);
+    return path.resolve(process.cwd(), customOutputDirFromArgs);
+  }
+
+  const { path: configPath, exists } = await findPlaywrightConfig();
+  console.log(
+    `Config file search result: ${exists ? configPath : "not found"}`
+  );
+
+  if (exists) {
+    const outputDirFromConfig = await extractOutputDirFromConfig(configPath);
+    if (outputDirFromConfig) {
+      console.log(`Using outputDir from config: ${outputDirFromConfig}`);
+      return outputDirFromConfig;
+    }
+  }
+
+  console.log(`Using default outputDir: ${DEFAULT_OUTPUT_DIR}`);
+  return path.resolve(process.cwd(), DEFAULT_OUTPUT_DIR);
+}

package/scripts/generate-email-report.mjs

@@ -2,6 +2,7 @@
 
 import * as fs from "fs/promises";
 import path from "path";
+import { getOutputDir } from "./config-reader.mjs";
 
 // Use dynamic import for chalk as it's ESM only
 let chalk;
@@ -23,6 +24,15 @@ const DEFAULT_OUTPUT_DIR = "pulse-report";
 const DEFAULT_JSON_FILE = "playwright-pulse-report.json";
 const MINIFIED_HTML_FILE = "pulse-email-summary.html"; // New minified report
 
+const args = process.argv.slice(2);
+let customOutputDir = null;
+for (let i = 0; i < args.length; i++) {
+  if (args[i] === "--outputDir" || args[i] === "-o") {
+    customOutputDir = args[i + 1];
+    break;
+  }
+}
+
 function sanitizeHTML(str) {
   if (str === null || str === undefined) return "";
   return String(str).replace(/[&<>"']/g, (match) => {
@@ -652,10 +662,20 @@ function generateMinifiedHTML(reportData) {
   `;
 }
 async function main() {
-  const outputDir = path.resolve(process.cwd(), DEFAULT_OUTPUT_DIR);
+  const outputDir = await getOutputDir(customOutputDir);
   const reportJsonPath = path.resolve(outputDir, DEFAULT_JSON_FILE);
   const minifiedReportHtmlPath = path.resolve(outputDir, MINIFIED_HTML_FILE); // Path for the new minified HTML
 
+  console.log(chalk.blue(`Generating email report...`));
+  console.log(chalk.blue(`Output directory set to: ${outputDir}`));
+  if (customOutputDir) {
+    console.log(chalk.gray(`  (from CLI argument)`));
+  } else {
+    console.log(
+      chalk.gray(`  (auto-detected from playwright.config or using default)`)
+    );
+  }
+
   // Step 2: Load current run's data
   let currentRunReportData;
   try {