webpack-sane-compiler-notifier
v2.1.1
Published
Notify webpack compilation status to your operating system when using webpack-sane-compiler
Downloads
800
Readme
webpack-sane-compiler-notifier
Notify webpack compilation status to your operating system when using webpack-sane-compiler.
Installation
$ npm install webpack-sane-compiler-notifier --save-dev
Usage
const startNotifying = require('webpack-sane-compiler-notifier');
const { stop, options } = startNotifying(compiler, {/* options */});
// Call compiler.run() or compiler.watch() to start a compilation and you will see OS notifications showing up
// Calling stop() will stop listening to the compiler events
// Furthermore, you have access to the options that were computed by the merge of provided options and the defaults
Available options
| Name | Description | Type | Default |
| ------ | ------------- | -------- | ------- |
| title | The title for the notification | string | package.json name
|
| icon | The icon for the notification | string | webpack-logo.png |
| sound | Play a sound when notifying on OS that support it | string | false |
Tests
$ npm test
$ npm test -- --watch
during development