feat: add workbox.autoRegister option

Resolves #46
kevinmarrec · Oct 11, 2022 · 76ecf22 · 76ecf22
1 parent 79063ef
commit 76ecf22
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/codecov.yaml b/codecov.yaml
@@ -0,0 +1 @@
+github_checks: false
diff --git a/src/module.ts b/src/module.ts
@@ -53,6 +53,7 @@ export default defineNuxtModule<PWAOptions>({
       twitterCreator: undefined,
     },
     workbox: {
+      autoRegister: true,
       enabled: !nuxt.options.dev,
       templatePath: null,
       workboxVersion: '6.5.3',

diff --git a/src/parts/workbox/index.ts b/src/parts/workbox/index.ts
@@ -18,16 +18,19 @@ export default async (pwa: PWAContext) => {
   if (!options.workboxUrl)
     options.workboxUrl = `https://storage.googleapis.com/workbox-cdn/releases/${options.workboxVersion}/workbox-sw.js`
 
-  // Service Worker
+  // Define Service Worker
   addTemplate({
     src: options.templatePath ? await pwa._resolver.resolvePath(options.templatePath) : pwa._resolver.resolve('../templates/workbox/sw.js'),
     dst: join(pwa._buildDir, 'sw.js'),
     write: true,
     options,
   })
 
-  nuxt.hook('nitro:config', (config) => {
-    config.plugins = config.plugins || []
-    config.plugins.push(pwa._resolver.resolve('./runtime/nitro-plugin'))
-  })
+  // Register Service Worker
+  if (options.autoRegister) {
+    nuxt.hook('nitro:config', (config) => {
+      config.plugins = config.plugins || []
+      config.plugins.push(pwa._resolver.resolve('./runtime/nitro-plugin'))
+    })
+  }
 }
diff --git a/src/parts/workbox/types.ts b/src/parts/workbox/types.ts
@@ -1,4 +1,5 @@
 export interface WorkboxOptions {
+  autoRegister: boolean
   enabled: boolean
   templatePath: string | null
   workboxVersion: string