wdio-ctrf-json-reporter - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "wdio-ctrf-json-reporter",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -1,10 +0,10 @@
-# Webdriverio JSON Reporter - CTRF
+# Webdriverio JSON Reporter
 
-A WDIO test reporter to generate JSON test reports that are [CTRF](https://ctrf.io) compliant.
+A WDIO JSON test reporter to create test reports that follow the CTRF standard.
 
-[Common Test Report Format](https://ctrf.io) helps you generate consistent JSON reports that are agnostic of specific programming languages or test frameworks.
+[Common Test Report Format](https://ctrf.io) ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.
 
 ## Features
 
-- Generate JSON test reports that are [CTRF](https://ctrf.io) compliant
+- Generate JSON test reports that follow [CTRF](https://ctrf.io) standard
 - Straightforward integration with WDIO
@@ -14,4 +14,42 @@
 
-A JSON test report schema that is the same structure, no matter which testing tool is used. It's created to provide consistent test reporting agnostic of specific programming languages or testing frameworks. Where many testing frameworks exist, each generating JSON reports in their own way, CTRF provides a standardised schema helping you generate the same report anywhere.
+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.
+
+```json
+{
+  "results": {
+    "tool": {
+      "name": "webdriverio"
+    },
+    "summary": {
+      "tests": 1,
+      "passed": 1,
+      "failed": 0,
+      "pending": 0,
+      "skipped": 0,
+      "other": 0,
+      "start": 1706828654274,
+      "stop": 1706828655782
+    },
+    "tests": [
+      {
+        "name": "ctrf should generate the same report with any tool",
+        "status": "passed",
+        "duration": 100
+      }
+    ],
+    "environment": {
+      "appName": "MyApp",
+      "buildName": "MyBuild",
+      "buildNumber": "1"
+    }
+  }
+}
+```
+
 ## Installation
@@ -26,4 +64,4 @@
 ```javascript
-   reporters: [
-        ['ctrf-json', {}]],
+reporters: [
+  ['ctrf-json', {}]],
 ```
@@ -30,0 +68,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13243

increased by6.5%

Number of lines in readme file

104

increased by57.58%

No dependency changes