Package Exports

progress-bar-webpack-plugin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (progress-bar-webpack-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

progress-bar-webpack-plugin

Installation

npm i -D progress-bar-webpack-plugin

Usage

Include the following in your Webpack config.

var ProgressBarPlugin = require('progress-bar-webpack-plugin');

...

plugins: [
  new ProgressBarPlugin()
]

Options

Accepts almost all of the same options as node-progress.

format the format of the progress bar
width the displayed width of the progress bar defaulting to total
complete completion character defaulting to "="
incomplete incomplete character defaulting to "-"
renderThrottle minimum time between updates in milliseconds defaulting to 16
clear option to clear the bar on completion defaulting to false
callback optional function to call when the progress bar completes

The format option accepts the following tokens:

:bar the progress bar itself
:current current tick number
:total total ticks
:elapsed time elapsed in seconds
:percent completion percentage

The default format uses the :bar and :percent tokens.

Use chalk to sprinkle on a few colors.

To include the time elapsed and prevent the progress bar from being cleared on build completion:

new ProgressBarPlugin({
  format: '  build [:bar] ' + chalk.green.bold(':percent') + ' (:elapsed seconds)',
  clear: false
})

All options other than width will be ignored in a non-TTY context (process.stdout.isTTY is false).

License

MIT