workbox-brunch

Adds Workbox Build support to brunch.

Usage

Install the plugin via npm with npm install --save-dev workbox-brunch.

Or, do manual install:

• Add "workbox-brunch": "~x.y.z" to package.json of your brunch app.
• If you want to use git version of plugin, use the GitHub URI "workbox-brunch": "brunch/workbox-brunch".

Configuration

Look at all workbox-build generateSW available options.

Config example:

workbox: {
  globDirectory: 'public/',
  globPatterns: ['**/*.*'],
  swDest: 'public/sw.js'
}

All what you need is register service worker for your app.

Register service worker example:

if ('serviceWorker' in navigator) {
    navigator.serviceWorker.register('/sw.js', { scope: '/' })
        .then(registration => {
            console.log('Service worker registration succeeded:', registration);
        })
        .catch(error => {
            console.log('Service worker registration failed:', error);
        });
} else {
    console.log('Service workers are not supported.');
}

License

The MIT License (MIT)

Copyright (c) 2019 Kamil Piskorski (https://mvpdoers.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.