@statoscope/stats-validator-plugin-webpack

stats-validator-plugin-webpack

Webpack stats validator plugin for @statoscope/stats-validator

This package contains rules to validate a webpack bundle.

Usage

1. Install

   npm i -D @statoscope/stats-validator-plugin-webpack

2. Add into statoscope.config.js

   module.exports = {
     validate: {
       // add webpack plugin with rules
       plugins: ['@statoscope/webpack'],
       rules: {
         // ensures that build-time of your bundle hasn't exceeded 10 sec
         '@statoscope/webpack/build-time-limits': ['error', {global: 10000}],
         // any other rules
       }
     }
   }   
   

Rules

• build-time-limits - Ensures that the build time has not exceeded the limit
• diff-build-time-limits - Compares build time between input and reference stats. Fails if build time has increased
• diff-deprecated-modules - Compares usage of specified modules between input and reference stats
• diff-deprecated-packages - Compares usage of specified packages usage between input and reference stats
• diff-entry-download-size-limits - Diff download size of entrypoints between input and reference stats
• diff-entry-download-time-limits - Diff download time of entrypoints between input and reference stats
• entry-download-size-limits - Ensure that the download size of entrypoints is not over the limit
• entry-download-time-limits - Ensure that the download time of entrypoints is not over the limit
• no-modules-deopts - Ensures that bundle doesn't have modules with deoptimization
• no-packages-dups - Ensures that bundle hasn't package duplicates
• restricted-modules - Ensures that bundle doesn't use specified modules
• restricted-packages - Ensures that bundle doesn't use specified packages

Changelog

5.9.0 (27 September 2021)

Features

• [stats-extension-custom-reports] - add package for passing custom reports to the UI (#108)

• [webpack-plugin] - support custom reports (#108)

• [webpack-ui] - support custom reports (#108)

• [helpers] - support lock/unlock for Resolver (#107) By default, all the resolvers is locked (no items can be added to resolver storage)

  const resolver = makeResolver(modules, m => m.identifier);
  modules.push(fooModule);
  resolver('foo'); // null
  resolver.unlock(); // allow to fetch resolver storage for new elements
  modules.push(fooModule);
  resolver('foo'); // fooModule
  

  In other words, locked resolver remembers its source items and ignores any source changes.

  It is useful for performance.

• [helpers] - add Indexer to build an index (#108) Index is more complex of resolver. It provides some API to manipulate its storage:

  const moduleIndex = makeIndex(module => module.identifier); // no source needed
  moduleIndex.add(fooModule);
  moduleIndex.get('foo'); // fooModule
  moduleIndex.get('bar'); // null
  moduleIndex.add(barModule);
  moduleIndex.get('bar'); // barModule
  moduleIndex.getAll(); // [fooModule, barModule]
  

• [stats-extension-compressed] - support indexer (#108)

• [stats-extension-package-info] - support indexer (#108)

• [stats-extension-stats-validation-result] - support indexer (#108)

• [config] - add requireConfig (#108)

• [cli] - support requireConfig (#108)

• [cli] - add makeReplacer helper to create json replacer (#107)

• [webpack-model] - add __statoscope.context field (#107)

• [report-writer] - remove context path from stats (it makes all the path relative from context) (#107)

• [webpack-plugin] - remove context path from stats (it makes all the path relative from context) (#107)

• [webpack-stats-extension-package-info] - remove context path from stats (it makes all the path relative from context) (#107)

Refactor

• [webpack-model] - use module.identifier to resolve a module (#107)

• [webpack-model] - decouple extension and compilation (#108)

  Extensions have attached to files, not to compilations

• [webpack-ui] - use module.identifier to resolve a module (#107)

• [webpack-stats-extension-compressed] - use module.identifier to resolve a module (#107)

• [stats-validator-plugin-webpack] - use module.identifier to resolve a module (#107)

Fixes

• [webpack-model] - not fail when incomplete stats have used