feat: options.dev

Author: pooya parsa

docs/modules/workbox.md

@@ -28,6 +28,10 @@ workbox: {
 
 (Object) Options to be passed to workbox before using it's modules. By default `debug` field will be set to `false` for production builds.
 
+### `dev`
+
+(Boolean) Enable workbox in dev mode of nuxt. (Disabled by default)
+
 ### `importScripts`
 
 (Array) Additional scripts to be imported in service worker script. (Relative to `/`. Can be placed in `assets/` directory)

packages/workbox/lib/defaults.js

@@ -4,6 +4,8 @@ module.exports = {
 
   config: {},
 
+  dev: false,
+
   importScripts: [],
 
   offline: true,

packages/workbox/lib/options.js

@@ -21,7 +21,8 @@ function getOptions (moduleOptions) {
 
   // swTemplate
   if (!options.swTemplate) {
-    options.swTemplate = path.resolve(__dirname, `../templates/sw${this.options.dev ? '.dev' : ''}.js`)
+    const disabled = this.options.dev && !options.dev
+    options.swTemplate = path.resolve(__dirname, `../templates/sw${disabled ? '.disable' : ''}.js`)
   }
 
   // swDest
@@ -70,7 +71,7 @@ function getOptions (moduleOptions) {
   // Workbox Config
   if (!options.config.debug) {
     // Debug field is by default set to true for localhost domain which is not always ideal
-    options.config.debug = this.options.dev
+    options.config.debug = options.dev || this.options.dev
   }
 
   return options

packages/workbox/templates/sw.dev.js

@@ -0,0 +1 @@
+// THIS FILE SHOULD NOT BE VERSION CONTROLLED

packages/workbox/templates/sw.disable.js

@@ -22,6 +22,7 @@ module.exports = {
 
   workbox: {
     offlineAnalytics: true,
+    dev: true,
     config: {
       debug: true
     },