@statoscope/cli - npm Package Compare versions

Comparing version 5.7.1 to 5.7.2

package.json

 {
   "name": "@statoscope/cli",
-  "version": "5.7.1",
+  "version": "5.7.2",
   "description": "Statoscope CLI tools",
@@ -24,11 +24,11 @@ "scripts": {
     "@discoveryjs/json-ext": "^0.5.3",
-    "@statoscope/config": "5.7.1",
+    "@statoscope/config": "5.7.2",
     "@statoscope/helpers": "5.7.1",
     "@statoscope/report-writer": "5.7.1",
-    "@statoscope/stats-validator": "5.7.1",
+    "@statoscope/stats-validator": "5.7.2",
     "@statoscope/stats-validator-reporter-console": "5.7.1",
-    "@statoscope/stats-validator-reporter-stats-report": "5.7.1",
+    "@statoscope/stats-validator-reporter-stats-report": "5.7.2",
     "@statoscope/types": "5.7.1",
     "@statoscope/webpack-model": "5.7.1",
-    "@statoscope/webpack-ui": "5.7.1",
+    "@statoscope/webpack-ui": "5.7.2",
     "@types/yargs": "^17.0.0",
@@ -38,3 +38,3 @@ "open": "^8.0.4",
   },
-  "gitHead": "064a4cec944bc1438f48afbe8c127f22d82b4a60"
+  "gitHead": "6de06d66c82f9a56f76ccc09807b7c2fe8515ae0"
 }

README.md

@@ -33,4 +33,37 @@ # Statoscope CLI
 
-This command uses [stats-validator](/statoscope/statoscope/packages/stats-validator). Please look at this package for more info
+This command uses [stats-validator](/packages/stats-validator). Please look at this package for more info
 
+**Example:**
+
+1. Create a statosope-config:
+
+**statoscope.config.js**
+```js
+module.exports = {
+  validate: {
+    // add webpack plugin with rules
+    plugins: ['@statoscope/webpack'],
+    reporters: [
+      // console-reporter to output results into cinsole (enabled by default)
+      '@statoscope/console',
+      // reporter that henerates UI-report with validation-results
+      ['@statosope/stats-report', {open: true}],
+    ],
+    rules: {
+      // ensures that build-time of your bundle hasn't exceeded 10 sec
+      '@statoscope/webpack/build-time-limits': ['error', {global: 10000}],
+      // any other rules
+    }
+  }
+}
+```
+
+2. Exec the command:
+
+```sh
+statoscope validate --input path/to/stats.json
+```
+
+3. Analyze results in the console or in generated UI-report
+
 ### serve
@@ -37,0 +70,0 @@

No alert changes

Improved metrics

Total package byte prevSize

19787

increased by3.95%

Number of lines in readme file

109

increased by43.42%

Dependency changes

• + Added@statoscope/config@5.7.2(transitive)

• + Added@statoscope/stats-validator@5.7.2(transitive)

• + Added@statoscope/stats-validator-reporter-stats-report@5.7.2(transitive)

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

• - Removed@statoscope/config@5.7.1(transitive)

• - Removed@statoscope/stats-validator@5.7.1(transitive)

• - Removed@statoscope/stats-validator-reporter-stats-report@5.7.1(transitive)

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

• Updated@statoscope/config@5.7.2

• Updated@statoscope/stats-validator@5.7.2

• Updated@statoscope/stats-validator-reporter-stats-report@5.7.2

• Updated@statoscope/webpack-ui@5.7.2