1.2.0 • Published 7 years ago

nyan-progress-webpack-plugin v1.2.0

Weekly downloads
609
License
ISC
Repository
github
Last release
7 years ago

nyan-progress-webpack-plugin

Meow

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)
NameSignatureDefault ValueDescription
loggerfunction(message, ...)console.logFunction used for logging
hookStdoutBooleantrueIf true, patches process.stdout.write during progress and counts extraneous log messages, to position Nyan Cat properly
getProgressMessagefunction(progress, messages, styles)...Gets custom progress message. styles is provided for convenience (exported from ansi-styles module)
debounceIntervalNumber180Defines how often getProgressMessage is called (in milliseconds)
nyanCatSaysfunction(progress, messages)progress === 1 && 'Nyan!'Override this function to define what nyan cat is saying
restoreCursorPositionBooleanfalseEnable this flag, if your terminal supports saving/restoring cursor position, for better output handling