@statoscope/stats-validator-reporter-stats-report - npm Package Compare versions

Comparing version 5.7.1 to 5.7.2

package.json

 {
   "name": "@statoscope/stats-validator-reporter-stats-report",
-  "version": "5.7.1",
+  "version": "5.7.2",
   "description": "Stats report reporter for @statoscope/stats-validator",
@@ -27,6 +27,6 @@ "main": "./dist/index.js",
     "@statoscope/types": "5.7.1",
-    "@statoscope/webpack-ui": "5.7.1",
+    "@statoscope/webpack-ui": "5.7.2",
     "open": "^8.2.1"
   },
-  "gitHead": "064a4cec944bc1438f48afbe8c127f22d82b4a60"
+  "gitHead": "6de06d66c82f9a56f76ccc09807b7c2fe8515ae0"
 }

README.md

@@ -8,4 +8,21 @@ # stats-validator-reporter-stats-report
 
-Injects validator's result into stats and generates a Statoscope report 
+Injects validator's result into stats and generates a Statoscope report.
 
+## Usage
+
+1. Install
+
+   `npm i -D @statoscope/stats-validator-plugin-webpack`
+2. Add into `statoscope.config.js`
+    ```js
+    module.exports = {
+      validate: {
+        reporters: [["@statoscope/stats-report", { "open": true }]]
+        // any other config parts
+      }
+    }   
+    ```
+
+In this case, Statoscope validator will generate a UI-report and open it.
+
 ## Options
@@ -40,2 +57,14 @@
   "validate": {
+    "reporters": [["@statoscope/stats-report", { "saveStatsTo": "/path/to/report.html" }]]
+  }
+}
+```
+
+Generate UI report info `/path/to/report.html` file.
+
+**statoscope.config.js:**
+
+```json
+{
+  "validate": {
     "reporters": [["@statoscope/stats-report", { "saveStatsTo": "/path/to/new/stats.json" }]]
@@ -46,2 +75,2 @@ }
 
-Just inject validation result into stats and save it.
+Just inject validation result into stats and save into `/path/to/new/stats.json` file.

No alert changes

Improved metrics

Total package byte prevSize

10702

increased by6.04%

Number of lines in readme file

74

increased by64.44%

Dependency changes

• + Added@statoscope/webpack-ui@5.7.2(transitive)

• - Removed@statoscope/webpack-ui@5.7.1(transitive)

• Updated@statoscope/webpack-ui@5.7.2