workbox-webpack-plugin - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

build/index.js

@@ -5,2 +5,3 @@ const swBuild = require('workbox-build');
  * Use the instance of this in the plugins array of the webpack config.
+ *
  * @example
@@ -20,13 +21,13 @@ * const WorkboxBuildWebpackPlugin = require('workbox-webpack-plugin');
  *   plugins: [
- *   	new WorkboxBuildWebpackPlugin({
+ *    new WorkboxBuildWebpackPlugin({
  *      globDirectory: './build/',
- *      staticFileGlobs: ['**\/*.{html,js,css}'],
+ *      globPatterns: ['**\/*.{html,js,css}'],
  *      globIgnores: ['admin.html'],
  *      swSrc: './src/sw.js',
  *      swDest: './build/sw.js',
- *   	});
+ *     });
  *   ]
  * }
  *
- * @class WorkboxBuildWebpackPlugin
+ * @module workbox-webpack-plugin
  */
@@ -37,4 +38,3 @@ class WorkboxBuildWebpackPlugin {
    *
-   * @param {Object} [config] all the options as passed to `swbuild`
-   * @memberOf WorkboxBuildWebpackPlugin
+   * @param {Object} [config] All the options as passed to `workbox-build`.
    */
@@ -64,5 +64,4 @@ constructor(config) {
   /**
+   * @private
    * @param {Object} [compiler] default compiler object passed from webpack
-   *
-   * @memberOf WorkboxBuildWebpackPlugin
    */
@@ -69,0 +68,0 @@ apply(compiler) {

package.json

 {
   "name": "workbox-webpack-plugin",
-  "version": "0.0.2",
-  "description": "This is a webpack plugin for workbox.",
+  "version": "0.0.3",
+  "description": "A plugin for your Webpack build process, helping you generate a manifest of local files that workbox-sw should precache.",
   "keywords": [
@@ -26,3 +26,3 @@ "workbox",
   "dependencies": {
-    "workbox-build": "^0.0.2"
+    "workbox-build": "^0.0.3"
   },
@@ -32,4 +32,4 @@ "author": "Google's Web DevRel Team",
   "repository": "googlechrome/sw-helpers",
-  "bugs": "https://github.com/googlechrome/sw-helpers/issues",
-  "homepage": "https://github.com/GoogleChrome/sw-helpers/tree/master/packages/workbox-webpack-plugin"
+  "bugs": "https://github.com/GoogleChrome/workbox/issues",
+  "homepage": "https://github.com/GoogleChrome/workbox/tree/master/packages/workbox-webpack-plugin"
 }

README.md

@@ -1,15 +0,27 @@
-<!-- DO NOT EDIT. This page is autogenerated. -->
-<!-- To make changes, edit templates/Project-README.hbs, not this file. -->
-
 # workbox-webpack-plugin
 
-This is a webpack plugin for workbox
+A plugin for your [Webpack](https://webpack.js.org/) build process, helping you
+generate a manifest of local files that [`workbox-sw`](../workbox-sw) should
+precache.
 
 ## Installation
 
-`npm install --save-dev workbox-webpack-plugin`
+```sh
+npm install --save-dev workbox-webpack-plugin
+```
 
+## Documentation
 
-## Reference Docs
+Read more at this module's [documentation page](https://workboxjs.org/reference-docs/latest/module-workbox-webpack-plugin.html).
 
-You can find [documentation for this module here](https://googlechrome.github.io/sw-helpers/reference-docs/stable/latest/module-workbox-webpack-plugin.html#main).
+## Documentation
+
+Read more at this module's
+[getting starting page](https://workboxjs.org/get-started/webpack).
+
+# What's Workbox?
+
+This module is a part of Workbox, which is a collection of JavaScript libraries
+for [Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/).
+
+Visit https://workboxjs.org/ to learn more about what Workbox can do for you.

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 bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15076

increased by2.47%

Number of lines in readme file

28

increased by75%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Lines of code

74

decreased by-1.33%

Dependency changes

• + Addedworkbox-build@0.0.3(transitive)

• + Addedworkbox-sw@0.0.3(transitive)

• - Removedworkbox-build@0.0.2(transitive)

• - Removedworkbox-sw@0.0.2(transitive)

• Updatedworkbox-build@^0.0.3