# nyan-progress-webpack-plugin

> Meow

Latest version **1.2.0** (published 2017-03-16) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2017-03-16 |
| First published | 2015-07-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 170 |
| Author | Alexander |
| Maintainers | alexkuz |
| Keywords | webpack, plugin, progress, nyan, meow |

## Links

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

## Dependencies (3)

- [ansi-styles](https://npm.io/package/ansi-styles.md) ^3.0.0
- [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^1.1.0
- [object.assign](https://npm.io/package/object.assign.md) ^4.0.4

## 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

- 1.2.0 (latest) — 2017-03-16
- 1.1.4 — 2015-11-21
- 1.1.3 — 2015-09-19
- 1.1.2 — 2015-09-11
- 1.1.1 — 2015-09-10
- 1.1.0 — 2015-09-10
- 1.0.3 — 2015-07-29
- 1.0.2 — 2015-07-25
- 1.0.1 — 2015-07-25
- 1.0.0 — 2015-07-05

## README

# nyan-progress-webpack-plugin
Meow

<img src="nyanLight.png" width="400px" /> <img src="nyanDark.png" width="400px" />

## Install

```
$ npm i -D nyan-progress-webpack-plugin
```

## Usage

Add this to your webpack plugin:

```
var NyanProgressPlugin = require('nyan-progress-webpack-plugin');

...

plugins: [
  new NyanProgressPlugin()  
]

...
```

**NB**: use `webpack.ProgressPlugin` carefully with this plugin. If you used it just for progress logging, you can remove it.

## Options
```
new NyanProgressPlugin(options)
```
| Name | Signature | Default Value | Description |
|------|-----------|---------------|-------------|
| logger | `function(message, ...)` | `console.log` | Function used for logging |
| hookStdout | Boolean | `true` | If `true`, patches `process.stdout.write` during progress and counts extraneous log messages, to position Nyan Cat properly |
| getProgressMessage | `function(progress, messages, styles)` | `...` | Gets custom progress message. `styles` is provided for convenience (exported from [ansi-styles](https://github.com/chalk/ansi-styles) module) |
| debounceInterval | Number | `180` | Defines how often `getProgressMessage` is called (in milliseconds) |
| nyanCatSays | `function(progress, messages)` | `progress === 1 && 'Nyan!'` | Override this function to define what nyan cat is saying |
| restoreCursorPosition | Boolean | `false` | Enable this flag, if your terminal supports saving/restoring cursor position, for better output handling |

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