ortoni-report 1.0.0 → 1.0.2

package/dist/ortoni-report.d.ts

@@ -0,0 +1,14 @@
+import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
+
+declare class OrtoniReport implements Reporter {
+    private results;
+    private groupedResults;
+    private suiteName;
+    onBegin(config: FullConfig, suite: Suite): void;
+    onTestBegin(test: TestCase, result: TestResult): void;
+    onTestEnd(test: TestCase, result: TestResult): void;
+    onEnd(result: FullResult): void;
+    generateHTML(): string;
+}
+
+export { OrtoniReport as default };

package/dist/ortoni-report.js

@@ -0,0 +1,146 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// ortoni-report.ts
+var ortoni_report_exports = {};
+__export(ortoni_report_exports, {
+  default: () => OrtoniReport
+});
+module.exports = __toCommonJS(ortoni_report_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_handlebars = __toESM(require("handlebars"));
+var import_safe = __toESM(require("colors/safe"));
+var OrtoniReport = class {
+  results = [];
+  groupedResults;
+  suiteName;
+  onBegin(config, suite) {
+    this.results = [];
+    const screenshotsDir = import_path.default.join(__dirname, "screenshots");
+    if (!import_fs.default.existsSync(screenshotsDir)) {
+      import_fs.default.mkdirSync(screenshotsDir);
+    }
+  }
+  onTestBegin(test, result) {
+  }
+  onTestEnd(test, result) {
+    console.log(test.titlePath());
+    const testResult = {
+      projectName: test.titlePath()[1],
+      // Get the project name
+      suite: test.titlePath()[3],
+      // Adjust the index based on your suite hierarchy
+      title: test.title,
+      status: result.status,
+      duration: result.duration,
+      errors: result.errors.map((e) => import_safe.default.strip(e.message || e.toString())),
+      steps: result.steps.map((step) => ({
+        title: step.title,
+        category: step.category,
+        duration: step.duration,
+        status: result.status
+      })),
+      logs: import_safe.default.strip(result.stdout.concat(result.stderr).map((log) => log).join("\n")),
+      screenshotPath: null,
+      filePath: test.titlePath()[2]
+    };
+    if (result.attachments) {
+      const screenshotsDir = import_path.default.join(__dirname, "screenshots\\" + test.id);
+      if (!import_fs.default.existsSync(screenshotsDir)) {
+        import_fs.default.mkdirSync(screenshotsDir);
+      }
+      const screenshot = result.attachments.find((attachment) => attachment.name === "screenshot");
+      if (screenshot && screenshot.path) {
+        const screenshotContent = import_fs.default.readFileSync(screenshot.path, "base64");
+        const screenshotFileName = `screenshots/${test.id}/${import_path.default.basename(screenshot.path)}`;
+        import_fs.default.writeFileSync(import_path.default.join(__dirname, screenshotFileName), screenshotContent, "base64");
+        testResult.screenshotPath = screenshotFileName;
+      }
+    }
+    this.results.push(testResult);
+  }
+  onEnd(result) {
+    this.groupedResults = this.results.reduce((acc, result2, index) => {
+      const filePath = result2.filePath;
+      const suiteName = result2.suite;
+      const projectName = result2.projectName;
+      if (!acc[filePath]) {
+        acc[filePath] = {};
+      }
+      if (!acc[filePath][suiteName]) {
+        acc[filePath][suiteName] = {};
+      }
+      if (!acc[filePath][suiteName][projectName]) {
+        acc[filePath][suiteName][projectName] = [];
+      }
+      acc[filePath][suiteName][projectName].push({ ...result2, index });
+      return acc;
+    }, {});
+    import_handlebars.default.registerHelper("json", function(context) {
+      return safeStringify(context);
+    });
+    import_handlebars.default.registerHelper("splitSuiteName", function(suiteName) {
+      return suiteName.split(" - ");
+    });
+    const html = this.generateHTML();
+    const outputPath = import_path.default.join(__dirname, "ortoni-report.html");
+    import_fs.default.writeFileSync(outputPath, html);
+    console.log(`Ortoni HTML report generated at ${outputPath}`);
+  }
+  generateHTML() {
+    const templateSource = import_fs.default.readFileSync(import_path.default.join(__dirname, "report-template.hbs"), "utf-8");
+    const template = import_handlebars.default.compile(templateSource);
+    const data = {
+      suiteName: this.suiteName,
+      results: this.results,
+      passCount: this.results.filter((r) => r.status === "passed").length,
+      failCount: this.results.filter((r) => r.status === "failed").length,
+      skipCount: this.results.filter((r) => r.status === "skipped").length,
+      retryCount: this.results.filter((r) => r.status === "retry").length,
+      totalCount: this.results.length,
+      groupedResults: this.groupedResults
+    };
+    return template(data);
+  }
+};
+function safeStringify(obj, indent = 2) {
+  const cache = /* @__PURE__ */ new Set();
+  const json = JSON.stringify(obj, (key, value) => {
+    if (typeof value === "object" && value !== null) {
+      if (cache.has(value)) {
+        return;
+      }
+      cache.add(value);
+    }
+    return value;
+  }, indent);
+  cache.clear();
+  return json;
+}

package/dist/ortoni-report.mjs

@@ -0,0 +1,115 @@
+// ortoni-report.ts
+import fs from "fs";
+import path from "path";
+import Handlebars from "handlebars";
+import colors from "colors/safe";
+var OrtoniReport = class {
+  results = [];
+  groupedResults;
+  suiteName;
+  onBegin(config, suite) {
+    this.results = [];
+    const screenshotsDir = path.join(__dirname, "screenshots");
+    if (!fs.existsSync(screenshotsDir)) {
+      fs.mkdirSync(screenshotsDir);
+    }
+  }
+  onTestBegin(test, result) {
+  }
+  onTestEnd(test, result) {
+    console.log(test.titlePath());
+    const testResult = {
+      projectName: test.titlePath()[1],
+      // Get the project name
+      suite: test.titlePath()[3],
+      // Adjust the index based on your suite hierarchy
+      title: test.title,
+      status: result.status,
+      duration: result.duration,
+      errors: result.errors.map((e) => colors.strip(e.message || e.toString())),
+      steps: result.steps.map((step) => ({
+        title: step.title,
+        category: step.category,
+        duration: step.duration,
+        status: result.status
+      })),
+      logs: colors.strip(result.stdout.concat(result.stderr).map((log) => log).join("\n")),
+      screenshotPath: null,
+      filePath: test.titlePath()[2]
+    };
+    if (result.attachments) {
+      const screenshotsDir = path.join(__dirname, "screenshots\\" + test.id);
+      if (!fs.existsSync(screenshotsDir)) {
+        fs.mkdirSync(screenshotsDir);
+      }
+      const screenshot = result.attachments.find((attachment) => attachment.name === "screenshot");
+      if (screenshot && screenshot.path) {
+        const screenshotContent = fs.readFileSync(screenshot.path, "base64");
+        const screenshotFileName = `screenshots/${test.id}/${path.basename(screenshot.path)}`;
+        fs.writeFileSync(path.join(__dirname, screenshotFileName), screenshotContent, "base64");
+        testResult.screenshotPath = screenshotFileName;
+      }
+    }
+    this.results.push(testResult);
+  }
+  onEnd(result) {
+    this.groupedResults = this.results.reduce((acc, result2, index) => {
+      const filePath = result2.filePath;
+      const suiteName = result2.suite;
+      const projectName = result2.projectName;
+      if (!acc[filePath]) {
+        acc[filePath] = {};
+      }
+      if (!acc[filePath][suiteName]) {
+        acc[filePath][suiteName] = {};
+      }
+      if (!acc[filePath][suiteName][projectName]) {
+        acc[filePath][suiteName][projectName] = [];
+      }
+      acc[filePath][suiteName][projectName].push({ ...result2, index });
+      return acc;
+    }, {});
+    Handlebars.registerHelper("json", function(context) {
+      return safeStringify(context);
+    });
+    Handlebars.registerHelper("splitSuiteName", function(suiteName) {
+      return suiteName.split(" - ");
+    });
+    const html = this.generateHTML();
+    const outputPath = path.join(__dirname, "ortoni-report.html");
+    fs.writeFileSync(outputPath, html);
+    console.log(`Ortoni HTML report generated at ${outputPath}`);
+  }
+  generateHTML() {
+    const templateSource = fs.readFileSync(path.join(__dirname, "report-template.hbs"), "utf-8");
+    const template = Handlebars.compile(templateSource);
+    const data = {
+      suiteName: this.suiteName,
+      results: this.results,
+      passCount: this.results.filter((r) => r.status === "passed").length,
+      failCount: this.results.filter((r) => r.status === "failed").length,
+      skipCount: this.results.filter((r) => r.status === "skipped").length,
+      retryCount: this.results.filter((r) => r.status === "retry").length,
+      totalCount: this.results.length,
+      groupedResults: this.groupedResults
+    };
+    return template(data);
+  }
+};
+function safeStringify(obj, indent = 2) {
+  const cache = /* @__PURE__ */ new Set();
+  const json = JSON.stringify(obj, (key, value) => {
+    if (typeof value === "object" && value !== null) {
+      if (cache.has(value)) {
+        return;
+      }
+      cache.add(value);
+    }
+    return value;
+  }, indent);
+  cache.clear();
+  return json;
+}
+export {
+  OrtoniReport as default
+};

package/{report-template.hbs → dist/report-template.hbs}

@@ -162,7 +162,7 @@
     <script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/3.7.0/chart.min.js"></script>
     <script>
         document.addEventListener('DOMContentLoaded', () => {
-            const testData = {{{ json results }}};
+        const testData = {{{ json results }}};
         const testDetails = document.getElementById('testDetails');
         const summary = document.getElementById('summary');
         const backButton = document.querySelector('.back-button');

package/ortoni-report.ts

@@ -8,8 +8,8 @@ import type {
 } from '@playwright/test/reporter';
 
 interface TestResultData {
-    projectName: string;
-    suite: string;
+    projectName: any;
+    suite: any;
     title: string;
     status: string;
     duration: number;
@@ -17,7 +17,7 @@ interface TestResultData {
     steps: any[];
     logs: string;
     screenshotPath: string | null;
-    filePath: string
+    filePath: any;
 }
 export default class OrtoniReport implements Reporter {
     private results: TestResultData[] = [];
@@ -101,9 +101,9 @@ export default class OrtoniReport implements Reporter {
             return suiteName.split(' - ');
         });
         const html = this.generateHTML();
-        const outputPath = path.join(__dirname, 'advanced-playwright-report.html');
+        const outputPath = path.join(__dirname, 'ortoni-report.html');
         fs.writeFileSync(outputPath, html);
-        console.log(`Advanced HTML report generated at ${outputPath}`);
+        console.log(`Ortoni HTML report generated at ${outputPath}`);
     }
     generateHTML() {
         const templateSource = fs.readFileSync(path.join(__dirname, 'report-template.hbs'), 'utf-8');

package/package.json

@@ -1,25 +1,22 @@
 {
   "name": "ortoni-report",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Playwright Report By LetCode Koushik",
-  "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsup ortoni-report.ts --format cjs,esm --dts",
+    "release": "npm publish",
+    "lint": "tsc"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ortoniKC/letcode-pw-report.git"
   },
   "keywords": [
-    "playwright",
-    "playwright",
-    "report",
-    "letcode",
-    "koushik",
-    "report",
-    "ortoni",
-    "ortoni",
-    "report"
+    "playwright report",
+    "playwright letcode",
+    "letcode koushik",
+    "ortoni report",
+    "ortoni"
   ],
   "author": "Koushik Chatterjee (LetCode with Koushik)",
   "license": "ISC",
@@ -34,6 +31,12 @@
   },
   "devDependencies": {
     "@playwright/test": "^1.44.1",
-    "@types/node": "^20.14.2"
-  }
+    "@types/node": "^20.14.2",
+    "@changesets/cli": "^2.26.0",
+    "tsup": "^6.5.0",
+    "typescript": "^4.9.4"
+  },
+  "main": "dist/ortoni-report.js",
+  "module": "dist/ortoni-report.mjs",
+  "types": "dist/ortoni-report.d.ts"
 }

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+      /* Base Options: */
+      "moduleResolution":"Node",
+      "esModuleInterop": true,
+      "skipLibCheck": true,
+      "target": "es2022",
+      "allowJs": true,
+      "moduleDetection": "force",
+      /* Strictness */
+      "strict": true,
+      "noUncheckedIndexedAccess": true,
+      /* If NOT transpiling with TypeScript: */
+      "module": "ESNext",
+      "noEmit": true,
+      /* If your code runs in the DOM: */
+      "lib": ["es2022", "dom", "dom.iterable"],
+    }
+  }