webpack-build-notifier - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1-alpha

CHANGELOG.md

 # Changelog
 
+#### 2.1.1
+
+###### _December 10, 2020_
+
+- Updated node-notifier to fix [#59](/../../issues/59).
+
 #### 2.1.0
@@ -4,0 +10,0 @@

dist/types.d.ts

@@ -143,3 +143,3 @@ import NotificationCenter from 'node-notifier/notifiers/notificationcenter';
     /**
-     * Any additional node-notifier options as documented in the node-notifer documentation:
+     * Any additional node-notifier options as documented in the node-notifier documentation:
      * https://github.com/mikaelbr/node-notifier
@@ -146,0 +146,0 @@ *

package.json

 {
   "name": "webpack-build-notifier",
-  "version": "2.1.0",
+  "version": "2.1.1-alpha",
   "description": "A Webpack plugin that generates OS notifications for build steps using node-notifier.",
@@ -38,3 +38,3 @@ "main": "dist/index.js",
   "dependencies": {
-    "node-notifier": "7.0.1",
+    "node-notifier": "8.0.0",
     "strip-ansi": "^6.0.0"
@@ -44,3 +44,3 @@ },
     "@types/jest": "^25.2.3",
-    "@types/node-notifier": "^6.0.1",
+    "@types/node-notifier": "8.0.0",
     "@types/strip-ansi": "^5.2.1",
@@ -62,2 +62,2 @@ "@types/webpack": "^4.41.13",
   }
-}
+}

README.md

 # webpack-build-notifier
 
-A [Webpack](https://webpack.github.io/) plugin that uses the [node-notifier](https://github.com/mikaelbr/node-notifier) module to display OS-level notifications for Webpack build errors and warnings.
+A [Webpack](https://webpack.github.io/) plugin that uses the [node-notifier](https://github.com/mikaelbr/node-notifier) package to display OS-level notifications for Webpack build events.
 
+**webpack-build-notifier** can generate notifications for compilation warnings and errors, as well as notify you when the compilation process is triggered and completes successfully. Take a look at the [Config Options](#config-options) to learn more about what **webpack-build-notifier** can do.
+
 [![NPM version](https://img.shields.io/npm/v/webpack-build-notifier.svg)](https://www.npmjs.org/package/webpack-build-notifier)
-
 [![Build Status](https://travis-ci.com/RoccoC/webpack-build-notifier.svg?branch=master)](https://travis-ci.com/RoccoC/webpack-build-notifier)
-
 [![Coverage Status](https://coveralls.io/repos/github/RoccoC/webpack-build-notifier/badge.svg?branch=master)](https://coveralls.io/github/RoccoC/webpack-build-notifier?branch=master)
@@ -19,3 +19,3 @@
 // webpack.config.js
-var WebpackBuildNotifierPlugin = require('webpack-build-notifier');
+const WebpackBuildNotifierPlugin = require('webpack-build-notifier');
 
@@ -26,5 +26,5 @@ module.exports = {
     new WebpackBuildNotifierPlugin({
-      title: "My Project Webpack Build",
+      title: "My Webpack Project",
       logo: path.resolve("./img/favicon.png"),
-      suppressSuccess: true
+      suppressSuccess: true, // don't spam success notifications
     })
@@ -90,20 +90,20 @@ ],
 #### successIcon
-The absolute path to the icon to be displayed for success notifications. Defaults to the included **_./icons/success.png_**.
+The absolute path to the icon to be displayed for success notifications. Defaults to the included **_./src/icons/success.png_**.
 
-![Success](https://github.com/RoccoC/webpack-build-notifier/blob/master/icons/success.png?raw=true "Success")
+![Success](https://github.com/RoccoC/webpack-build-notifier/blob/master/src/icons/success.png?raw=true "Success")
 
 #### warningIcon
-The absolute path to the icon to be displayed for warning notifications. Defaults to the included **_./icons/warning.png_**.
+The absolute path to the icon to be displayed for warning notifications. Defaults to the included **_./src/icons/warning.png_**.
 
-![Warning](https://github.com/RoccoC/webpack-build-notifier/blob/master/icons/warning.png?raw=true "Warning")
+![Warning](https://github.com/RoccoC/webpack-build-notifier/blob/master/src/icons/warning.png?raw=true "Warning")
 
 #### failureIcon
-The absolute path to the icon to be displayed for failure notifications. Defaults to the included **_./icons/failure.png_**.
+The absolute path to the icon to be displayed for failure notifications. Defaults to the included **_./src/icons/failure.png_**.
 
-![Failure](https://github.com/RoccoC/webpack-build-notifier/blob/master/icons/failure.png?raw=true "Failure")
+![Failure](https://github.com/RoccoC/webpack-build-notifier/blob/master/src/icons/failure.png?raw=true "Failure")
 
 #### compileIcon
-The absolute path to the icon to be displayed for compilation started notifications. Defaults to the included **_./icons/compile.png_**.
+The absolute path to the icon to be displayed for compilation started notifications. Defaults to the included **_./src/icons/compile.png_**.
 
-![Compile](https://github.com/RoccoC/webpack-build-notifier/blob/master/icons/compile.png?raw=true "Compile")
+![Compile](https://github.com/RoccoC/webpack-build-notifier/blob/master/src/icons/compile.png?raw=true "Compile")
 
@@ -121,3 +121,3 @@ #### messageFormatter
 #### notifyOptions
-Any additional node-notifier options as documented in the [node-notifer documentation](https://github.com/mikaelbr/node-notifier).
+Any additional node-notifier options as documented in the [node-notifier documentation](https://github.com/mikaelbr/node-notifier).
 Note that options provided here will only be applied to the success/warning/error notifications (not the "compilation started" notification). The title, message, sound, contentImage (logo), and icon options will be ignored, as they will be set via the corresponding WebpackBuildNotifier config options (either user-specified or default).
@@ -144,5 +144,5 @@
     new WebpackBuildNotifierPlugin({
-      title: "My Project Webpack Build",
+      title: "My Webpack Project",
       logo: path.resolve("./img/favicon.png"),
-      suppressSuccess: true
+      suppressSuccess: true, // don't spam success notifications
     })
@@ -156,7 +156,2 @@ ],
 
-Future Improvements
--------------------
-* ~~Port to TypeScript~~ (completed in v2.0.0)
-* ~~Increase test coverage~~ (completed in v2.0.0)
-
 Notes
@@ -168,3 +163,3 @@ -----
 
-Given the purpose and similarities, this project probably should have been a fork of one of these.
+Given the purpose and similarities, this project probably could have been a fork of one of these.
 
@@ -174,2 +169,2 @@ Changelog
 
-View the changelog [here](CHANGELOG.md).
+View the changelog [here](CHANGELOG.md).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

113733

increased by0.3%

Worsened metrics

Number of low quality alerts

2

increased by100%

Number of lines in readme file

163

decreased by-2.4%

Dependency changes

• + Addednode-notifier@8.0.0(transitive)

• + Addeduuid@8.3.2(transitive)

• - Removednode-notifier@7.0.1(transitive)

• - Removeduuid@7.0.3(transitive)

• Updatednode-notifier@8.0.0