# progress-bar-webpack-plugin

> A progress bar for Webpack.

Latest version **2.1.0** (published 2020-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install progress-bar-webpack-plugin
pnpm add progress-bar-webpack-plugin
yarn add progress-bar-webpack-plugin
bun add progress-bar-webpack-plugin
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2020-01-14 |
| First published | 2015-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/progress-bar-webpack-plugin) |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 428 |
| Author | Chris Gaudreau |
| Maintainers | clessg |
| Keywords | webpack, plugin, progress, bar |

## Links

- npm: https://www.npmjs.com/package/progress-bar-webpack-plugin
- Repository: https://github.com/clessg/progress-bar-webpack-plugin
- Homepage: https://github.com/clessg/progress-bar-webpack-plugin#readme
- Issues: https://github.com/clessg/progress-bar-webpack-plugin/issues
- npm.io page: https://npm.io/package/progress-bar-webpack-plugin

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [progress](https://npm.io/package/progress.md) ^2.0.3

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 2.1.0 (latest) — 2020-01-14
- 2.0.0 — 2020-01-14
- 1.12.1 — 2019-01-29
- 1.12.0 — 2019-01-22
- 1.11.0 — 2018-02-21
- 1.10.0 — 2017-07-10
- 1.9.3 — 2017-01-19
- 1.9.2 — 2017-01-03
- 1.9.1 — 2016-12-22
- 1.9.0 — 2016-08-01
- 1.8.0 — 2016-05-19
- 1.7.0 — 2016-05-19
- 1.6.0 — 2016-03-19
- 1.5.0 — 2016-03-03
- 1.4.1 — 2016-02-23
- … 5 more at https://npm.io/package/progress-bar-webpack-plugin/versions

## README

# progress-bar-webpack-plugin
![progress-bar-webpack-plugin](http://i.imgur.com/OIP1gnj.gif)

## Installation

```
npm i -D progress-bar-webpack-plugin
```

## Usage

Include the following in your Webpack config.

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

...

plugins: [
  new ProgressBarPlugin()
]
```

## Options

Accepts almost all of the same options as [node-progress](https://github.com/tj/node-progress#options).

- `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](https://github.com/chalk/chalk) to sprinkle on a few colors.

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

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

## License

MIT

---
_Source: https://npm.io/package/progress-bar-webpack-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._