progress-bar-webpack-plugin

A progress bar plugin for Webpack.

  • Owner: clessg/progress-bar-webpack-plugin
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

progress-bar-webpack-plugin

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 true
  • callback optional function to call when the progress bar completes
  • stream the output stream defaulting to stderr
  • summary option to show summary of time taken defaulting to true
  • summaryContent optional custom summary message if summary option is false
  • customSummary optional function to display a custom summary (passed build time)

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
  • :msg current progress message

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
})

License

MIT

Main metrics

Overview
Name With Ownerclessg/progress-bar-webpack-plugin
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 1)
Platform
License:MIT License
所有者活动
Created At2015-10-20 19:23:23
Pushed At2022-05-23 20:56:40
Last Commit At2022-05-23 20:56:09
Release Count20
Last Release Namev2.1.0 (Posted on 2020-01-14 07:41:29)
First Release Name1.0.0 (Posted on )
用户参与
Stargazers Count430
Watchers Count4
Fork Count38
Commits Count76
Has Issues Enabled
Issues Count26
Issue Open Count13
Pull Requests Count13
Pull Requests Open Count2
Pull Requests Close Count1
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private