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


License: MIT

Language: TypeScript


fork-ts-checker-notifier-webpack-plugin

npm Version build node version

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. 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 yarn to install packages:

yarn add --dev fork-ts-checker-webpack-plugin fork-ts-checker-notifier-webpack-plugin

Alternatively, use npm:

npm install --save-dev fork-ts-checker-webpack-plugin 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 = {
  /**
   * Plugin order is important.
   * A wrong order will cause some hooks to be undefined
   * and the build to fail
   */
  plugins: [
    new ForkTsCheckerWebpackPlugin(),
    new ForkTsCheckerNotifierWebpackPlugin({ excludeWarnings: true }),
  ]
},

Configuration

Title

Title prefix shown in the notifications.

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

Exclude Warnings

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

new ForkTsCheckerNotifierWebpackPlugin({ excludeWarnings: true });

Always Notify

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

new ForkTsCheckerNotifierWebpackPlugin({ 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 ForkTsCheckerNotifierWebpackPlugin({ skipFirstNotification: true });

Skip Notification for successfull builds

Skip notifications for successful builds.

new ForkTsCheckerNotifierWebpackPlugin({ skipSuccessful: true });

Project Statistics

Sourcerank 10
Repository Size 505 KB
Stars 35
Forks 9
Watchers 1
Open issues 5
Dependencies 638
Contributors 9
Tags 14
Created
Last updated
Last pushed

Top Contributors See all

John Reilly dependabot[bot] n0v1 Patryk Wojtasik Tomáš Szabo sakito Rolands Jegorovs Christopher Deutsch developer-lindner

Packages Referencing this Repo

fork-ts-checker-notifier-webpack-plugin
a notifier for users of fork-ts-checker-webpack-plugin
Latest release 1.0.3 - Updated - 35 stars

Recent Tags See all

v1.0.3 December 09, 2019
v1.0.2 June 03, 2019
v1.0.1 June 03, 2019
v1.0.0 March 07, 2019
v1.0.0-alpha.1 January 04, 2019
v1.0.0-alpha.0 December 24, 2018
v0.6.2 September 26, 2018
v0.6.1 September 25, 2018
v0.6.0 September 11, 2018
v0.6.0 September 11, 2018
v0.5.0 September 10, 2018
v0.2.0 July 06, 2017
v0.1.4 May 14, 2017
v0.1.3 May 13, 2017

Something wrong with this page? Make a suggestion

Last synced: 2019-12-09 21:47:01 UTC

Login to resync this repository