npmpackage.info

webpack-notifier

webpack + node-notifier = build status system notifications

1.15.0

306

ISC

TypeScript

18.27 kB

135,541,568 2.6

Installations

npm install webpack-notifier

Pull Requests

Open

2

Total

37

Closed

7

Merged

28

Issues

Open

2

Total

38

Closed

36

Releases

v1.3.0

Published on 22 Feb 2016

View all 1 releases

Developer

Turbo87

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

14.18.0

NPM Version

6.14.15 Statistics

306 Stars

222 Commits

41 Forks

7 Watching

3 Branches

20 Contributors

Updated on 16 Jul 2024

Bundle Size

56.36 kB

Minified

18.27 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (53.34%)

JavaScript (46.66%)

Total Downloads

Cumulative downloads

Total Downloads

135,541,568

Last day

-11.2%

99,431

Compared to previous day

Last week

-7.9%

577,389

Compared to previous week

Last month

33.4%

2,790,691

Compared to previous month

Last year

-11.4%

25,300,006

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

webpack-notifier

npm bundle size

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:

1var WebpackNotifierPlugin = require('webpack-notifier');
2
3var config = module.exports = {
4  // ...
5
6  plugins: [
7    new WebpackNotifierPlugin(),
8  ]
9}

Configuration

All `node-notifier` options

You can use any node-notifier options (depending on your OS) Except for options generated by the plugin itself:

title - it can be not only a string, but also a function
message - generated based on the value of other options
contentImage - it can be an object with images for different statuses
icon - matches with contentImage

Title

Title shown in the notification.

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

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

Emojis in message text

Show status emoji icon before the message.

1new WebpackNotifierPlugin({emoji: true});

Content Image

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

String path:

1var path = require('path');
2
3new WebpackNotifierPlugin({contentImage: path.join(__dirname, 'logo.png')});

Object string path:

1var path = require('path');
2
3const statusesPaths = {
4  success: path.join(__dirname, 'success.png'),
5  warning: path.join(__dirname, 'warning.png'),
6  error: path.join(__dirname, 'error.png')
7}
8
9new WebpackNotifierPlugin({contentImage: statusesPaths});

Exclude Warnings

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

1new WebpackNotifierPlugin({excludeWarnings: true});

Always Notify

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

1new WebpackNotifierPlugin({alwaysNotify: true});

Notify on error

Trigger a notification only on error.

1new 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.

1new WebpackNotifierPlugin({skipFirstNotification: true});

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:104: update your workflow using https://app.stepsecurity.io/secureworkflow/Turbo87/webpack-notifier/ci.yml/master?enable=pin
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to webpack-notifier

simple-update-notifier

2.0.0

Simple update notifier to check for npm updates for cli applications

node-notifier

10.0.1

A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback)

webpack-notifier-2

2.5.0

webpack + node-notifier = build status system notifications

webpack-build-notifier

3.1.0

A Webpack plugin that generates OS notifications for build steps using node-notifier.

webpack-notifier

Installations

Pull Requests

2

37

7

28

Issues

2

38

36

Releases

Developer

Turbo87

Developer Guide

CommonJS

Yes

14.18.0

6.14.15

Statistics

Bundle Size

56.36 kB

18.27 kB

Languages

Total Downloads

135,541,568

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

webpack-notifier

Installation

Usage

Configuration

All node-notifier options

Title

Emojis in message text

Content Image

String path:

Object string path:

Exclude Warnings

Always Notify

Notify on error

Skip Notification on the First Build

10

10

10

1

0

0

0

0

0

0

0

0

0

2.6

/10

Other packages similar to webpack-notifier

All `node-notifier` options