# webpack-simple-progress-plugin

> webpack plugin for showing simple progress bar

Latest version **0.0.5** (published 2021-05-14) · MIT license · 0 weekly downloads

## Install

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

## 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.5 |
| Published | 2021-05-14 |
| First published | 2016-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Hyunchul Kwak |
| Maintainers | hyunchulkwak |
| Keywords | webpack, plugin, progress |

## Links

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

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [progress](https://npm.io/package/progress.md) ^1.1.8
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.0

## 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.5 (latest) — 2021-05-14
- 0.0.4 — 2018-02-27
- 0.0.3 — 2017-10-26
- 0.0.2 — 2017-06-21
- 0.0.1 — 2016-10-10

## README

# webpack-simple-progress-plugin
![webpack-simple-progress-plugin](http://i.imgur.com/5G767Ag.gif)

## Install
```
$ npm install webpack-simple-progress-plugin --save-dev
```

## Usage
Add the plugin to your webpack config like below.
```
var SimpleProgressPlugin = require('webpack-simple-progress-plugin');
var webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'dist',
    filename: 'bundle.js'
  },
  plugins: [
    new SimpleProgressPlugin()
  ]
};
```

## Options
```
new SimpleProgressPlugin(options: object)
```
|property|type|description|
| -------- | ---- | ----------- |
| messageTemplate | string | A template of progress and message shown while bundling modules. You can also use [node-progress token](https://github.com/visionmedia/node-progress#tokens). ```:msg``` shows current message of [webpack ProgressPlugin](https://webpack.github.io/docs/list-of-plugins.html#progressplugin). |
| progressOptions | object | [node-progress options](https://github.com/visionmedia/node-progress#options) to draw progress bar. defaults are shown below.

#### defaults
```
{
  messageTemplate: [':bar', chalk.green(':percent'), ':msg'].join(' ')
  progressOptions: {
    complete: chalk.bgGreen(' '),
    incomplete: chalk.bgWhite(' '),
    width: 40,
    total: 100,
    clear: false
  }  
}
```

## License
MIT (http://www.opensource.org/licenses/mit-license.php)

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