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

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.

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.

In the webpack.config.js file:

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

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

  plugins: [
    new WebpackNotifierPlugin(),
  ]
},

Title shown in the notification.

// static title
new WebpackNotifierPlugin({title: 'Webpack'});
// or dynamicly generated
new WebpackNotifierPlugin({
    title({msg}) {
        if (msg.startsWith('Error')) return 'build error ❌';
        if (msg.startsWith('Warning')) return 'build warning ⚠️';
        return 'build complete ✅';
    },
})

Show status emoji icon before the message.

new WebpackNotifierPlugin({emoji: true});

Image shown in the notification.

var path = require('path');

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

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

new WebpackNotifierPlugin({excludeWarnings: true});

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

new WebpackNotifierPlugin({alwaysNotify: true});

Trigger a notification only on error.

new WebpackNotifierPlugin({onlyOnError: true});

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

new WebpackNotifierPlugin({skipFirstNotification: true});