webpack-notifier

!npm bundle size

This is a webpack plugin that uses the
node-notifier package to
display build status system notifications to the user.

!webpack-notifier screenshot

> This is a fork of the
webpack-error-notification
plugin. It adds support for Windows and there is no need to manually install
the terminal-notifier package on OS X anymore.

The plugin will notify you about the first run (success/fail),
all failed runs and the first successful run after recovering from
a build failure. In other words: it will stay silent if everything
is fine with your build.

Installation

Use npm to install this package:

npm install --save-dev webpack-notifier

Check the node-notifier
Requirements
whether you need to install any additional tools for your OS.

Usage

In the webpack.config.js file:

``js
var WebpackNotifierPlugin = require('webpack-notifier');

var config = module.exports = {
// ...

plugins: [
new WebpackNotifierPlugin(),
]
}
`

Configuration

$3

Title shown in the notification.

`js
new WebpackNotifierPlugin({title: 'Webpack'});
`

`js
new WebpackNotifierPlugin({title: function (params) {
return Build status is ${params.status} with message ${params.message};
}});
`

$3

Show status emoji icon before the message.

`js
new WebpackNotifierPlugin({emoji: true});
`

$3

Image shown in the notification. Can be a path string or object with paths.

#### String path:
`js
var path = require('path');

new WebpackNotifierPlugin({contentImage: path.join(__dirname, 'logo.png')});
`

#### Object string path:
`js
var path = require('path');

const statusesPaths = {
success: path.join(__dirname, 'success.png'),
warning: path.join(__dirname, 'warning.png'),
error: path.join(__dirname, 'error.png')
}

new WebpackNotifierPlugin({contentImage: statusesPaths});
`

$3

If set to true, warnings will not cause a notification.

`js
new WebpackNotifierPlugin({excludeWarnings: true});
`

$3

Trigger a notification every time. Call it "noisy-mode".

`js
new WebpackNotifierPlugin({alwaysNotify: true});
`

$3

Trigger a notification only on error.

`js
new WebpackNotifierPlugin({onlyOnError: true});
`

$3

Do not notify on the first build. This allows you to receive notifications on subsequent incremental builds without being notified on the initial build.

`js
new WebpackNotifierPlugin({skipFirstNotification: true});
``