Git Product home page Git Product logo

craco-workbox's Introduction

craco-workbox

Prerequisites

Install craco

Install

yarn add craco-workbox -D

# OR

npm install craco-workbox -S

Usage

  1. Add the plugin into your craco.config.js;
// craco.config.js

const CracoWorkboxPlugin = require('craco-workbox');

module.exports = {
    plugins: [{
        plugin: CracoWorkboxPlugin
    }]
}
  1. Add a workbox.config.js file to your project root containing the overrides you would like to pass. For a full list of options see https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#generatesw_plugin.
// workbox.config.js

module.exports = {
  GenerateSW: options => {
    // override GenerateSW config here
    // e.g. options.skipWaiting = true;
    return options;
  },
  InjectManifest: options => {
    // override InjectManifest config here
    // e.g. options.maximumFileSizeToCacheInBytes = 10 * 1024 * 1024;
    return options;
  }
};

License

Licensed under the MIT License, Copyright ©️ 2019 Kevin S. Perrine. See LICENSE for more information.

craco-workbox's People

Contributors

francescocretti avatar kevinsperrine avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

craco-workbox's Issues

~~Including this plugin causes craco build to fail~~ (delete this please)

Honestly I don't know how to debug this either.

~/projects/faineant feature/inline-wb*
❯ yarn build
yarn run v1.13.0
$ env NODE_ENV=production GENERATE_SOURCEMAP=false craco build
Creating an optimized production build...
Failed to compile.

Cannot use 'in' operator to search for 'globDirectory' in undefined


error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
zsh: exit 1     yarn build

craco.config.js:

const CracoWorkboxPlugin = require('craco-workbox');

module.exports = {
    plugins: [
        {
            plugin: CracoWorkboxPlugin
        }
    ]
}

And workbox.config.js:

module.exports = function(options) {
    options.importWorkboxFrom = 'local';
}

Anybody know if it is still working?

Not working on my end, but I don't have an error message either — seems like adding it to my config is having no effect.

Is it possible that something's become incompatible?

how to use InjectManifest instead GenerateSW

hello, @kevinsperrine , your package craco-workbox is great. I can successfully override GenerateSW options from provided one from CRA, e.g. add runtime caching and offline google analytics.

Now my app wants to integrate service worker with Firebase Cloud Messaging in order to receive web push notification in background state. I want to use InjectManifest from workbox-webpack-plugin without eject CRA. How to achieve that?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.