playwright-ctrf-json-reporter 0.0.13 → 0.0.15

package/README.md

@@ -2,6 +2,12 @@
 
 > Save Playwright test results as a JSON file
 
+![Static Badge](https://img.shields.io/badge/official-red?label=ctrf&labelColor=green)
+[![build](https://github.com/ctrf-io/playwright-ctrf-json-report/actions/workflows/main.yaml/badge.svg)](https://github.com/ctrf-io/playwright-ctrf-json-report/actions/workflows/main.yaml)
+![NPM Downloads](https://img.shields.io/npm/d18m/playwright-ctrf-json-reporter?logo=npm)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/playwright-ctrf-json-reporter?label=Size)
+![GitHub Repo stars](https://img.shields.io/github/stars/ctrf-io/playwright-ctrf-json-report)
+
 A Playwright JSON test reporter to create test reports that follow the CTRF standard.
 
 [Common Test Report Format](https://ctrf.io) ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.
@@ -22,7 +28,7 @@ The only way we can grow CTRF is with your help and the support of the software
 - Give this repository a star ⭐⭐⭐⭐⭐⭐
 - Follow the CTRF [GitHub organisation](https://github.com/ctrf-io)
 - Clap for our medium articles (30 times each) 👏
-- Share, share share! Discord, Reddit, Twitter, LinkedIn, Slack, Teams, whereever! - please share our [libraries](https://github.com/orgs/ctrf-io/repositories), our [homepage](https://www.ctrf.io/), our [Medium articles](https://medium.com/@ma11hewthomas)
+- Share our [libraries](https://github.com/orgs/ctrf-io/repositories), our [homepage](https://www.ctrf.io/), or [Medium articles](https://medium.com/@ma11hewthomas)
 - Maybe even write a blog about us!
 - Try our [tools](https://github.com/orgs/ctrf-io/repositories)
 
@@ -67,16 +73,6 @@ The only way we can grow CTRF is with your help and the support of the software
 }
 ```
 
-## What is CTRF?
-
-CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
-
-**Consistency Across Tools:** Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.
-
-**Language and Framework Agnostic:** It provides a universal reporting schema that works seamlessly with any programming language and testing framework.
-
-**Facilitates Better Analysis:** With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.
-
 ## Installation
 
 ```bash
@@ -130,6 +126,20 @@ reporter: [
 
 A comprehensive report is generated by default, with the exception of screenshots, which you must explicitly set to true.
 
+## Merge reports
+
+When running tests in parallel, each test shard has its own test report. If you want to have a combined report showing all the test results from all the shards, you can merge them.
+
+The [ctrf-cli](https://github.com/ctrf-io/ctrf-cli) package provides a method to merge multiple ctrf json files into a single file.
+
+After executing your tests, use the following command:
+
+```sh
+npx ctrf merge <directory>
+```
+
+Replace directory with the path to the directory containing the CTRF reports you want to merge.
+
 ## Test Object Properties
 
 The test object in the report includes the following [CTRF properties](https://ctrf.io/docs/schema/test):
@@ -225,6 +235,16 @@ test('example test', async ({ page }) => {
 
 The browser metadata file must be called metadata.json and contain properties name and version in the body.
 
+## What is CTRF?
+
+CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
+
+**Consistency Across Tools:** Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.
+
+**Language and Framework Agnostic:** It provides a universal reporting schema that works seamlessly with any programming language and testing framework.
+
+**Facilitates Better Analysis:** With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.
+
 ## Support Us
 
 If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.

package/dist/generate-report.js

@@ -67,8 +67,10 @@ class GenerateCtrfReport {
     onEnd() {
         this.ctrfReport.results.summary.stop = Date.now();
         if (this.suite !== undefined) {
-            this.processSuite(this.suite);
-            this.ctrfReport.results.summary.suites = this.countSuites(this.suite);
+            if (this.suite.allTests().length > 0) {
+                this.processSuite(this.suite);
+                this.ctrfReport.results.summary.suites = this.countSuites(this.suite);
+            }
         }
         this.writeReportToFile(this.ctrfReport);
     }
@@ -81,9 +83,14 @@ class GenerateCtrfReport {
         }
     }
     processTest(testCase) {
+        if (testCase.results.length === 0) {
+            return;
+        }
         const latestResult = testCase.results[testCase.results.length - 1];
-        this.updateCtrfTestResultsFromTestResult(testCase, latestResult, this.ctrfReport);
-        this.updateSummaryFromTestResult(latestResult, this.ctrfReport);
+        if (latestResult !== undefined) {
+            this.updateCtrfTestResultsFromTestResult(testCase, latestResult, this.ctrfReport);
+            this.updateSummaryFromTestResult(latestResult, this.ctrfReport);
+        }
     }
     setFilename(filename) {
         if (filename.endsWith('.json')) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-ctrf-json-reporter",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "A Playwright JSON test reporter to create test results reports",
   "main": "dist/index.js",
   "scripts": {