fork-ts-checker-notifier-webpack-plugin

This is a webpack plugin that uses the node-notifier package to display build status system notifications to the user. It's purpose is to work with the fork-ts-checker-webpack-plugin when it is being used with blockEmit: false. This deliberately has a similar API as the excellent webpack-notifier plugin. If you are not using fork-ts-checker-webpack-plugin and you want system notifications then you probably want webpack-notifier.

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 fork-ts-checker-notifier-webpack-plugin

Usage

In the webpack.config.js file:

var ForkTsCheckerNotifierWebpackPlugin = require('fork-ts-checker-notifier-webpack-plugin');
var ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');

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

  plugins: [
    new ForkTsCheckerNotifierWebpackPlugin({ excludeWarnings: true }),
    new ForkTsCheckerWebpackPlugin({
      watch: ['./src', './test'] // optional but improves performance (less stat calls)
    }),
  ]
},

Configuration

Title

Title prefix shown in the notifications.

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

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

Skip Notification for successfull builds

Skip notifications for successful builds.

new WebpackNotifierPlugin({skipSuccessful: true});

igogrek/fork-ts-checker-notifier-webpack-plugin