Skip to content

webpack + node-notifier = build status system notifications

License

Notifications You must be signed in to change notification settings

inoyakaigor/webpack-notifier-2

This branch is 43 commits ahead of, 124 commits behind Turbo87/webpack-notifier:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2048e1a · Oct 5, 2023
Aug 24, 2023
Feb 27, 2015
Aug 24, 2023
Dec 11, 2019
Feb 10, 2015
Aug 25, 2023
Feb 12, 2015
Oct 5, 2023
Aug 25, 2023
Feb 10, 2015
Aug 25, 2023
Aug 25, 2023
Aug 24, 2023

Repository files navigation

Webpack Notifier 2

badge 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-notifier which 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'});
var path = require('path');

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

Emojis in message text

var path = require('path');

new WebpackNotifierPlugin({emoji: true});

Content Image

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

String path:

var path = require('path');

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

Object string path:

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

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

Notify on error

Trigger a notification only on error.

new WebpackNotifierPlugin({onlyOnError: 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});

About

webpack + node-notifier = build status system notifications

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%