Turbo87/webpack-notifier


webpack + node-notifier = build status system notifications

License: ISC

Language: JavaScript


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});

Project Statistics

Sourcerank 16
Repository Size 84 KB
Stars 258
Forks 37
Watchers 5
Open issues 15
Dependencies 5
Contributors 14
Tags 16
Created
Last updated
Last pushed

Top Contributors See all

Tobias Bieniek Vsevolod Solovyov John Reilly Martijn Russchen opensrcken Carl Sverre Tomas Junnonen pavlin99th Kent C. Dodds Rizki Ardian Mikael Brevik Petr Bela Alexander Mextner Eric Lovett

Packages Referencing this Repo

webpack-notifier
webpack + node-notifier = build status system notifications
Latest release 1.8.0 - Updated - 258 stars
webpack-notifier-opensrcken
webpack + node-notifier = build status system notifications
Latest release 1.3.2-opensrcken - Updated - 258 stars
es-webpack-notifier
webpack + node-notifier = build status system notifications, Add support for Multi-compiler mode
Latest release 1.6.0 - Published - 258 stars

Recent Tags See all

v1.8.0 June 27, 2019
v1.7.0 October 10, 2018
v1.6.0 March 08, 2018
v1.5.1 January 20, 2018
v1.5.0 December 15, 2016
v1.4.1 August 25, 2016
v1.4.0 August 22, 2016
v1.3.2 August 04, 2016
v1.3.1 February 22, 2016
v1.3.0 February 22, 2016
v1.2.1 April 16, 2015
v1.2.0 March 15, 2015
v1.1.1 February 27, 2015
v1.1.0 February 27, 2015
v1.0.1 February 12, 2015

Something wrong with this page? Make a suggestion

Last synced: 2019-06-27 10:44:29 UTC

Login to resync this repository