react-app-rewire-workbox v2.0.1

react-app-rewire-workbox

Add the workbox-webpack-plugin to your create-react-app app via react-app-rewired without having to eject OR fork.

By default, create react app uses SWPrecacheWebpackPlugin under the hood to generate a service worker which pre-caches your app shell and assets. sw-precache and sw-toolbox are being phased out in favour of Workbox so ideally we'd like to use Workbox instead!

Create react app also doesn't let you customise your service worker AT ALL! This plugin allows you to easily use the GenerateSW and InjectManifest functions from Workbox Webpack plugin. See here for details on the configuration options for each method.

This plugin will remove the SWPrecacheWebpackPlugin from the Webpack plugin configuration and add the Workbox GenerateSW and InjectManifest plugin with your desired configuration.

Installation

yarn add workbox-webpack-plugin # OR npm install --save workbox-webpack-plugin
yarn add react-app-rewire-workbox # OR npm install --save react-app-rewire-workbox

# If you don't have it already already, you also need:
yarn add react-app-rewired # OR npm install --save react-app-rewired

Usage

1. In the config-overrides.js of the root of your project you created for react-app-rewired add this code (this example uses the GenerateSW version of Workbox for easy pre-caching functionality):

/* config-overrides.js */
const {rewireWorkboxGenerate} = require('react-app-rewire-workbox');

module.exports = function override(config, env) {
  if (env === "production") {
    console.log("Production build - Adding Workbox for PWAs");
    config = rewireWorkboxGenerate()(config, env);
  }

  return config;
};

2. Replace 'react-scripts' with 'react-app-rewired' in package.json

  "scripts": {
    "start": "react-app-rewired start",
    "build": "react-app-rewired build",
    "test": "react-app-rewired test --env=jsdom"
  },

That's it, you now have Workbox for all your service worker / 'progressive web app' needs!!

Advanced Usage / Configuration

Two functions are exported from this module: rewireWorkboxGenerate and rewireWorkboxInject. For info on how each Webpack plugin works, see the Google documentation.

If you call either function with no parameters, it will set a default configuration that works well with create-react-app. If you would like to add a custom config, pass it in as the parameter e.g.

const {rewireWorkboxInject, defaultInjectConfig} = require('react-app-rewire-workbox');
const path = require('path');

module.exports = function override(config, env) {
  if (env === "production") {
    console.log("Production build - Adding Workbox for PWAs");
    // Extend the default injection config with required swSrc
    const workboxConfig = {
      ...defaultInjectConfig,
      swSrc: path.join(__dirname, 'src', 'custom-sw.js')
    };
    config = rewireWorkboxInject(workboxConfig)(config, env);
  }

  return config;
};

For your convenience the default configs for both functions are also exported so you can easily override them. They are exported as defaultGenerateConfig and defaultInjectConfig.

License

Licensed under the MIT License, Copyright ©️ 2018 David Moodie. See LICENSE for more information.