# fig-webpack-progress

> webpack progress

Latest version **0.0.3** (published 2020-06-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install fig-webpack-progress
pnpm add fig-webpack-progress
yarn add fig-webpack-progress
bun add fig-webpack-progress
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-06-13 |
| First published | 2020-06-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | starkwang |
| Maintainers | shudong |
| Keywords | progress, webpack |

## Links

- npm: https://www.npmjs.com/package/fig-webpack-progress
- npm.io page: https://npm.io/package/fig-webpack-progress

## Dependencies (1)

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

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2020-06-13
- 0.0.2 — 2020-06-13
- 0.0.1 — 2020-06-13

## README

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

## Installation

```
npm i -D fig-webpack-progress
```

## Usage

Include the following in your Webpack config.

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

...

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/fig-webpack-progress · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._