@anilanar/sw-precache-webpack-plugin

SW Precache Webpack Plugin

SWPrecacheWebpackPlugin is a webpack plugin for using service workers to cache your external project dependencies. It will generate a service worker file using sw-precache and add it to your build directory.

Install

npm install --save-dev sw-precache-webpack-plugin

Basic Usage

var path = require('path');
var SWPrecacheWebpackPlugin = require('sw-precache-webpack-plugin');


module.exports = {
  context: __dirname,

  entry: {
    main: path.resolve(__dirname, 'src/index'),
  },

  output: {
    path: path.resolve(__dirname, 'src/bundles/'),
    filename: '[name]-[hash].js',
  },

  plugins: [
    new SWPrecacheWebpackPlugin(
      {
        cacheId: 'my-project-name',
        filename: 'my-service-worker.js',
        maximumFileSizeToCacheInBytes: 4194304,
        minify: true,
        runtimeCaching: [{
          handler: 'cacheFirst',
          urlPattern: /[.]mp3$/,
        }],
      }
    ),
  ]
}

This will generate a new service worker at src/bundles/my-service-worker.js. Then you would just register it in your application:

(function() {
  if('serviceWorker' in navigator) {
    navigator.serviceWorker.register('/my-service-worker.js');
  }
})();

Another example of registering a service worker is provided by GoogleChrome/sw-precache

Configuration

You can pass a hash of configuration options to SWPrecacheWebpackPlugin:

plugin options:

• filename: [String] - Service worker filename, default is service-worker.js
• filepath: [String] - Service worker path and name, default is to use webpack.output.path + options.filename. This will overried filename. Warning: Make the service worker available in the same directory it will be needed. This is because the scope of the service worker is defined by the directory the worker exists.
• staticFileGlobsIgnorePatterns: [RegExp] - Define an optional array of regex patterns to filter out of staticFileGlobs (see below)
• mergeStaticsConfig: [boolean] - Merge provided staticFileGlobs and stripPrefixMulti with webpack's config, rather than having those take precedence, default is false.
• minify: [boolean] - Set to true to minify and uglify the generated service-worker, default is false.
• forceDelete: [boolean] - Pass force option to del, default is false.

sw-precache options:

• cacheId: [String] - Not required but you should include this, it will give your service worker cache a unique name
• directoryIndex: [String]
• dynamicUrlToDependencies: [Object<String,Array<String>]
• handleFetch: [boolean]
• ignoreUrlParametersMatching: [Array<Regex>]
• importScripts: [Array<String>] - Add [hash] if you want to import a file generated with webpack [hash] ex. ['dist/some-[hash].js']
• logger: [function]
• maximumFileSizeToCacheInBytes: [Number]
• navigateFallbackWhitelist: [Array<RegExp>]
• replacePrefix: [String] - Should only be used in conjunction with stripPrefix
• runtimeCaching: [Array<Object>]
• staticFileGlobs: [Array<String>] - Omit this to allow the plugin to cache all your bundles' emitted assets. If mergeStaticsConfig=true: this value will be merged with your bundles' emitted assets, otherwise this value is just passed to sw-precache and emitted assets won't be included.
• stripPrefix: [String] - Same as stripPrefixMulti[stripPrefix] = ''
• stripPrefixMulti: [Object<String,String>] - Omit this to use your webpack config's output.path + '/': output.publicPath. If mergeStaticsConfig=true, this value will be merged with your webpack's output.path: publicPath for stripping prefixes. Otherwise this property will be passed directly to sw-precache and Webpack's output path won't be replaced.
• templateFilePath: [String]
• verbose: [boolean]

Note that all configuration options are optional. SWPrecacheWebpackPlugin will by default use all your assets emitted by webpack's compiler for the staticFileGlobs parameter and your webpack config's {[output.path + '/']: output.publicPath} as the stripPrefixMulti parameter. This behavior is probably what you want, all your webpack assets will be cached by your generated service worker. Just don't pass any arguments when you initialize this plugin, and let this plugin handle generating your sw-precache configuration.

Examples

See the examples documentation for more examples.

The simplest use case would be:

module.exports = {
  ...
  plugins: [
    new SWPrecacheWebpackPlugin(),
  ],
  ...
}

Here's an example using one option from sw-precache (cacheId) with one option from SWPrecacheWebpackPlugin (filename) in a configuration hash:

plugins: [
  new SWPrecacheWebpackPlugin(
    {
      cacheId: "my-project-name",
      filename: "my-project-service-worker.js",
    }
  ),
]

Here's a more elaborate example with mergeStaticsConfig: true and staticFileGlobsIgnorePatterns. mergeStaticsConfig: true allows you to add some additional static file globs to the emitted ServiceWorker file alongside Webpack's emitted assets. staticFileGlobsIgnorePatterns can be used to avoid including sourcemap file references in the generated ServiceWorker.

plugins: [
  new SWPrecacheWebpackPlugin(
    {
      cacheId: "my-project-name",
      filename: "my-project-service-worker.js",
      staticFileGlobs: [
        'src/static/img/**.*',
        'src/static/styles.css',
      ],
      stripPrefix: 'src/static/', // stripPrefixMulti is also supported
      mergeStaticsConfig: true, // if you don't set this to true, you won't see any webpack-emitted assets in your serviceworker config
      staticFileGlobsIgnorePatterns: [/\.map$/], // use this to ignore sourcemap files
    }
  ),
]

Webpack Dev Server Support

Currently SWPrecacheWebpackPlugin will not work with Webpack Dev Server. If you wish to test the service worker locally, you can use simple a node server see example project or python SimpleHTTPServer from your build directory. I would suggest pointing your node server to a different port than your usual local development port and keeping the precache service worker out of your local configuration (example).

Contributing

Install node dependencies:

  $ npm install

Add unit tests for your new feature in ./test/plugin.spec.js

Testing

Tests are located in ./test

Run tests:

  $ npm t