@olafalo/parcel-plugin-workbox

Parcel plugin to generate a workbox service worker

Usage no npm install needed!

<script type="module">
  import olafaloParcelPluginWorkbox from 'https://cdn.skypack.dev/@olafalo/parcel-plugin-workbox';
</script>

README

Parcel Plugin Workbox 3

issues last commit

Fork of parcel-plugin-workbox by Anders Dahnielson, with refactor from Cloud-CNC's fork

Install

npm i parcel-plugin-workbox -D

Usage

When you build with Parcel, this plugin will automatically run generateSWString. You can customize the settings by adding a workbox section to your package.json. The full configuration options can be found here.

This plugin will also automatically inject code for registering the service worker into index.html (currently hardcoded). For a working service worker that provides basic caching of Parcel dist files, you need only install this plugin—everything else will be automatic. Even workbox options in package.json are not necessary if the defaults work for you.

Example

package.json

{
  "workbox": {
    "importScripts": [
      "./worker.js"
    ],
  }
}

Note: importing package.json is generally considered insecure

FAQ

  • Whats different between this and the original?
    • Still maintained
    • Fixed uglify JS
    • Improved configuration support
      • Pass any configuration option you would normally pass to generateSWString
    • Local workbox copy
    • Reduced logging
    • Automatic injection of registration code
    • Removed the read-pkg-up/read-pkg/find-up/parse-json etc dependency chain that was responsible for 38 of the 94 dependencies despite being wholly replaceable by the single line of code JSON.parse(fs.readFileSync(path.resolve(process.cwd(), 'package.json'), 'utf-8'))