@statoscope/stats-validator-reporter-stats-report

stats-validator-reporter-stats-report

UI reporter for @statoscope/stats-validator.

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

   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

type Options = {
  saveReportTo?: string; // a path to save HTML report (temporary dir with random file name by default)
  saveStatsTo?: string; // a path to save JSON stats (does not save stats by default)
  open?: boolean; // open generated Statoscope report (false by default)
  disableReportCompression?: boolean // html report data compression, disable it will increase the size a lot (false by default)
};

Examples

statoscope.config.js:

{
  "validate": {
    "reporters": [["@statoscope/stats-report", { "open": true }]]
  }
}

Generate UI report and open it.

statoscope.config.js:

{
  "validate": {
    "reporters": [["@statoscope/stats-report", { "saveStatsTo": "/path/to/report.html" }]]
  }
}

Generate UI report info /path/to/report.html file.

statoscope.config.js:

{
  "validate": {
    "reporters": [["@statoscope/stats-report", { "saveStatsTo": "/path/to/new/stats.json" }]]
  }
}

Just inject validation result into stats and save into /path/to/new/stats.json file.

Changelog

5.27.0 (24 August 2023)

Features

• [webpack-model] - add module_retained_modules(module)-helper that returns retained modules by specific module

  In other words: retained ones will be removed from bundle along with the module

• [webpack-ui] - support module_retained_modules in module tree. For example, you can see retained modules in the diff-page

• [webpack-ui] - update discoveryjs from 1.0.0-beta.66 to 1.0.0-beta.77 (see changelog)

• [webpack-ui] - expose Discovery namespace

  import Statoscope from '@statoscope/webpack-ui';
  
  console.log(Statoscope.Discovery);
  

  See usage example in dev.html

• [webpack-ui] - expose Discovery data and view inspector that helps to debug custom statoscope reports

• [webpack-ui] - add npm run dev to develop Statoscope UI more easily

• [stats-validator-reporter-stats-report]: add disableReportCompression-option, disable it will increase the size a lot (false by default) (#210 by @icy0307)

• [report-writer]: use jsonxl to compress stats in binary json (replacement for old solution)

Performance

• [webpack-model] - improve initialization performance