ortoni-report 1.1.1 → 1.1.3

package/dist/utils/modal.js

@@ -0,0 +1,76 @@
+const isOpenClass = "modal-is-open";
+const openingClass = "modal-is-opening";
+const closingClass = "modal-is-closing";
+const scrollbarWidthCssVar = "--pico-scrollbar-width";
+const animationDuration = 400; // ms
+let visibleModal = null;
+
+// Toggle modal
+function toggleModal(event) {
+  event.preventDefault();
+  const modal = document.getElementById(event.currentTarget.dataset.target);
+  if (!modal) return;
+  if (modal) {
+    if (modal.open) {
+      closeModal(modal);
+    } else {
+      openModal(modal);
+    }
+  }
+}
+
+// Open modal
+function openModal(modal) {
+  const html = document.documentElement;
+  const scrollbarWidth = getScrollbarWidth();
+  if (scrollbarWidth) {
+    html.style.setProperty(scrollbarWidthCssVar, `${scrollbarWidth}px`);
+  }
+  html.classList.add(isOpenClass, openingClass);
+  setTimeout(function () {
+    visibleModal = modal;
+    html.classList.remove(openingClass);
+  }, animationDuration);
+  modal.showModal();
+}
+
+// Close modal
+function closeModal(modal) {
+  visibleModal = null;
+  const html = document.documentElement;
+  html.classList.add(closingClass);
+  setTimeout(function () {
+    html.classList.remove(closingClass, isOpenClass);
+    html.style.removeProperty(scrollbarWidthCssVar);
+    modal.close();
+  }, animationDuration);
+}
+
+// Close with a click outside
+document.addEventListener("click", function (event) {
+  if (visibleModal === null) return;
+  const modalContent = visibleModal.querySelector("article");
+  const isClickInside = modalContent.contains(event.target);
+  if (!isClickInside) {
+    closeModal(visibleModal);
+  }
+});
+
+// Close with Esc key
+document.addEventListener("keydown", function (event) {
+  if (event.key === "Escape" && visibleModal) {
+    closeModal(visibleModal);
+  }
+});
+
+// Get scrollbar width
+function getScrollbarWidth() {
+  const scrollbarWidth =
+    window.innerWidth - document.documentElement.clientWidth;
+  return scrollbarWidth;
+}
+
+// Is scrollbar visible
+function isScrollbarVisible() {
+  return document.body.scrollHeight > screen.height;
+}

package/dist/utils/utils.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDate = exports.normalizeFilePath = exports.msToTime = void 0;
+const path_1 = __importDefault(require("path"));
+function msToTime(duration) {
+    const milliseconds = Math.floor((duration % 1000));
+    const seconds = Math.floor((duration / 1000) % 60);
+    const minutes = Math.floor((duration / (1000 * 60)) % 60);
+    const hours = Math.floor((duration / (1000 * 60 * 60)) % 24);
+    let result = '';
+    if (hours > 0) {
+        result += (hours < 10 ? "0" + hours : hours) + "h:";
+    }
+    if (minutes > 0 || hours > 0) { // Include minutes if hours are included
+        result += (minutes < 10 ? "0" + minutes : minutes) + "m:";
+    }
+    if (seconds > 0 || minutes > 0 || hours > 0) { // Include seconds if minutes or hours are included
+        result += (seconds < 10 ? "0" + seconds : seconds) + "s";
+    }
+    if (milliseconds > 0) {
+        result += ":" + (milliseconds < 100 ? "0" + milliseconds : milliseconds) + "ms";
+    }
+    return result;
+}
+exports.msToTime = msToTime;
+function normalizeFilePath(filePath) {
+    // Normalize the path to handle different separators
+    const normalizedPath = path_1.default.normalize(filePath);
+    // Get the base name of the file (removes any leading directories)
+    return path_1.default.basename(normalizedPath);
+}
+exports.normalizeFilePath = normalizeFilePath;
+function formatDate(date) {
+    const day = String(date.getDate()).padStart(2, '0');
+    const month = date.toLocaleString('default', { month: 'short' });
+    const year = date.getFullYear();
+    const time = date.toLocaleTimeString();
+    return `${day}-${month}-${year} ${time}`;
+}
+exports.formatDate = formatDate;
+;

package/package.json

@@ -1,49 +1,47 @@
-{
-  "name": "ortoni-report",
-  "version": "1.1.1",
-  "description": "Playwright Report By LetCode with Koushik",
-  "scripts": {
-    "test": "npx playwright test",
-    "build": "tsup",
-    "release": "npm publish",
-    "lint": "tsc"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ortoniKC/ortoni-report"
-  },
-  "keywords": [
-    "playwright report",
-    "playwright letcode",
-    "letcode koushik",
-    "ortoni report",
-    "ortoni"
-  ],
-  "author": "Koushik Chatterjee (LetCode with Koushik)",
-  "license": "GPL-3.0-only",
-  "bugs": {
-    "url": "https://github.com/ortoniKC/ortoni-report/issues"
-  },
-  "homepage": "https://github.com/ortoniKC/ortoni-report#readme",
-  "dependencies": {
-    "colors": "^1.4.0",
-    "handlebars": "^4.7.8",
-    "hiq": "^4.2.3",
-    "rimraf": "^5.0.7"
-  },
-  "devDependencies": {
-    "@changesets/cli": "^2.26.0",
-    "@playwright/test": "^1.44.1",
-    "@types/node": "^20.14.2",
-    "tsup": "^6.5.0",
-    "typescript": "^4.9.4"
-  },
-  "main": "dist/ortoni-report.js",
-  "module": "dist/ortoni-report.mjs",
-  "types": "dist/ortoni-report.d.ts"
-}
+{
+  "name": "ortoni-report",
+  "version": "1.1.3",
+  "description": "Playwright Report By LetCode with Koushik",
+  "scripts": {
+    "test": "npx playwright test",
+    "build": "tsup",
+    "release": "npm publish",
+    "lint": "tsc"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ortoniKC/ortoni-report"
+  },
+  "keywords": [
+    "playwright report",
+    "playwright letcode",
+    "letcode koushik",
+    "ortoni report",
+    "ortoni-report",
+    "playwright html"
+  ],
+  "author": "Koushik Chatterjee (LetCode with Koushik)",
+  "license": "GPL-3.0-only",
+  "bugs": {
+    "url": "https://github.com/ortoniKC/ortoni-report/issues"
+  },
+  "homepage": "https://github.com/ortoniKC/ortoni-report#readme",
+  "dependencies": {
+    "colors": "^1.4.0",
+    "handlebars": "^4.7.8"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.44.1",
+    "@types/node": "^20.14.2",
+    "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/readme.md

@@ -2,9 +2,10 @@
 
 We are excited to announce the release of OrtoniReport (Playwright report - unofficial), a powerful and customizable HTML report generator for Playwright tests. This release includes key features that enhance the reporting capabilities and make it easier to visualize and organize test results.
 
-![Report](https://github.com/ortoniKC/ortoni-report/assets/58769833/da8c6b65-5f35-4fad-802a-039a72999cb1)
+[Click here to check the live Demo](https://ortoni.netlify.app/)
 
 
+![Ortoni Report](https://github.com/ortoniKC/ortoni-report/assets/58769833/88237970-b97f-4339-94cd-a1e4f3488b10)
 
 ## Features
 
@@ -20,9 +21,10 @@ We are excited to announce the release of OrtoniReport (Playwright report - unof
 
 4. **Summary Statistics:**
    - Provide summary statistics for total tests, passed tests, failed tests, skipped tests, and flaky tests.
+   - Success Rate of test suite.
 
 5. **Chart Visualization:**
-   - Visualize test results using a doughnut chart to represent the distribution of passed, failed, and skipped tests.
+   - Visualize test results using a doughnut chart to represent the distribution of passed, failed, skipped and flaky tests.
 
 6. **Project Information:**
    - Include project name, author name, and test type information in the report.
@@ -46,6 +48,14 @@ We are excited to announce the release of OrtoniReport (Playwright report - unof
 12. **Ease of Use:**
     - Enable easy navigation between test results and summary sections.
 
+13. **Success Rate**
+    - The success rate in this project is calculated based on the outcomes of the tests executed using Playwright. The calculation considers tests that pass initially as well as tests that initially fail but pass upon retry
+    - Success Rate Formula
+    The success rate (successRate) is calculated using the following formula:
+    ```
+    const successRate: string = (((passedTests + flakyTests) / totalTests) * 100).toFixed(2);
+    ```
+
 These features collectively enhance the readability, usability, and accessibility of the test report, providing valuable insights into test execution and results.
 
 ### Configurable Report Generation
@@ -53,7 +63,7 @@ These features collectively enhance the readability, usability, and accessibilit
   ```JS/TS
   reporter: [["ortoni-report",
     {
-      projectName: 'Plawright Sample',
+      projectName: 'LetCode Playwright Report',
       authorName: 'Koushik',
       testType: 'E2E'
     }],
@@ -86,12 +96,11 @@ Configure OrtoniReport in your `playwright.config.ts`:
 
 ``` javascript/typescript
 import { defineConfig } from '@playwright/test';
-import OrtoniReport from 'ortoni-report';
 
 export default defineConfig({
   reporter: [["ortoni-report",
     {
-      projectName: 'Plawright Sample',
+      projectName: 'LetCode Playwright Report',
       authorName: 'Koushik',
       testType: 'E2E'
     }],
@@ -124,4 +133,4 @@ Thank you for using OrtoniReport! We hope it significantly enhances your Playwri
 
 ---
 
-**LetCode with Koushik**
+**LetCode with Koushik**