@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.

Rules

• build-time-limits.md - Ensures that the build time has not exceeded the limit
• diff-build-time-limits.md - 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.7.0 (1 September 2021)

Features

• [stats-validator] - add package for validating stats
• [stats-validator-plugin-webpack] - add stats-validator plugin with webpack-rules
• [stats-validator-reporter-console] - add stats-validator reporter to output results into console
• [stats-validator-reporter-stats-report] - add stats-validator reporter to output results into descovery-based UI
• [stats-extension-stats-validation-result] - add stats extension to pass validation messages info descovery-based UI
• [config] - add package that contains config-helpers
• [webpack-ui] - support new validation results
  • support stats-extension-stats-validation-result
  • show badge in the main page
  • new page with validation results
  • new page with details of a validation message
  • mark entities (modules, chunks, packages, etc.) that have messages from the validator
  • show validation messages of the entities pages (modules, chunks, packages, etc.)
• [webpack-ui] - add some jora-helpers
  • resolveEntrypoint(id: string, hash: string): NormalizedEntrypointItem | null Resolve entrypoint by its name
  • resolveFile(id: string): NormalizedFile | null Resolve file by its name
  • resolveInputFile(): NormalizedFile | null Resolve file with input.json
  • resolveReferenceFile(): NormalizedFile | null Resolve file with reference.json
  • validation_getItems(hash?: string, relatedType?: RelatedItem['type'] | null, relatedId?: string | number): Item[] Get validation messages
  • validation_getItem(id?: number, hash?: string): Item | null Get validation message
  • validation_resolveRelatedItem(item?: RelatedItem, hash?: string): ResolvedRelatedItem Resolve an entity (module, chunk, etc.) that related with some message
  • validation_resolveRule(name?: string, hash?: string): RuleDescriptor | null Resolve detail info about a rule
• [cli] - support new validators in validate command
  • add reference-parameter
  • add config-parameter
  • use stats-validator package
• [types] - add package with statoscope ts-types
• [helpers] - add get-parameter into makeResolver-function
• [helpers] - add asciiTree-helper that generate ASCII tree from object-tree (useful for TTY-reporters)
• [helpers] - add a bunch of useful jora-helpers

  • typeof(value: unknown): string

    works like native typeof operator

  • isNullish(value: unknown): boolean

    returns true if value is null or undefined

  • isArray(value: unknown): boolean

    returns true if value is array

  • useNotNullish<T>(values: readonly T[]): T | null

    return first not-nullish element from values-array or null ([null, 123].useNotNullish() = 123)

  • serializeStringOrRegexp(value?: string | RegExp): SerializedStringOrRegexp | null

    transform string or regexp into json-compatible format

  • deserializeStringOrRegexp(value?: SerializedStringOrRegexp | null): string | RegExp | null

    reverse the result of serializeStringOrRegexp

  • semverSatisfies(version: string | SemVer, range: string | Range): boolean

    returns true if version satisfied of range

  • isMatch(a?: string, b?: string | RegExp): boolean

    returns true if a matches b

  • exclude<T>(
      items: readonly T[],
      params?: {
        exclude?: Array<string | RegExp>;
        get?: (arg: T) => string | undefined;
      }
    ): T[]
    

    Helps to exclude elements. Examples:

    • ['foo', 'bar', 'foo'].exclude({exclude: 'foo'}) = ['bar']
    • [fooCompilation, barCompilation, bazCompilation].exclude({exclude: /foo|bar/, get: <name>}) = [bazCompilation]

  • diff_normalizeLimit(limit?: number | Limit | null): Limit | null Normalize the limit

  • diff_isLTETheLimit(valueDiff: ValueDiff, limit?: number | Limit | null): boolean Returns true if valueDiff has not been exceeded the limit

Refactor

• [report-writer] - move transform function from cli
• [report-writer] - to-parameter of transform function now is required
• [report-writer] - from-parameter of transform might be file name or stats object
• [cli] - use transform from report-writer
• [helpers] - move prepareWithJora from webpack-model
• [webpck-model] - use prepareWithJora from helpers

Fixes

• [helpers] - fix max-parameter bug in graph_findPaths-helper

Deprecate

• [cli] - validator parameter in validate command (use statoscope config with rules instead)