Skip to content
webpack + node-notifier = build status system notifications
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example Add example folder to test the plugin Feb 27, 2015
.eslintrc.js
.gitignore
.travis.yml
CHANGELOG.md
LICENSE.md Update LICENSE.md Feb 12, 2015
README.md Add option to skip notifications on first build. Dec 14, 2016
index.js with --emoji icons Jun 26, 2019
logo.png Show webpack logo in notifications Feb 10, 2015
package.json
screenshot.png Updated README.md Feb 12, 2015

README.md

webpack-notifier

Build Status npm Version

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:

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

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

  plugins: [
    new WebpackNotifierPlugin(),
  ]
},

Configuration

Title

Title shown in the notification.

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

Content Image

Image shown in the notification.

var path = require('path');

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

Exclude Warnings

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

new WebpackNotifierPlugin({excludeWarnings: true});

Always Notify

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

new WebpackNotifierPlugin({alwaysNotify: true});

Skip Notification on the First Build

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});
You can’t perform that action at this time.