feat: Allow suppress workbox-build warnings in dev (#531)

vite-pwa · Jun 2, 2023 · 15b143f · 15b143f
1 parent 190ad03
commit 15b143f
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 8 deletions.
diff --git a/examples/vue-router/vite.config.ts b/examples/vue-router/vite.config.ts
@@ -36,6 +36,7 @@ const pwaOptions: Partial<VitePWAOptions> = {
     /* when using generateSW the PWA plugin will switch to classic */
     type: 'module',
     navigateFallback: 'index.html',
+    suppressWarnings: true,
   },
 }
 

diff --git a/scripts/build.ts b/scripts/build.ts
@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 import { commands } from './commands'
 
 for (const command of commands)

diff --git a/scripts/dev.ts b/scripts/dev.ts
@@ -1,4 +1,4 @@
-import { spawn } from 'child_process'
+import { spawn } from 'node:child_process'
 import { commands } from './commands'
 
 for (const command of commands)

diff --git a/scripts/run-examples.ts b/scripts/run-examples.ts
@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 import prompts from 'prompts'
 import {
   blue,

diff --git a/src/options.ts b/src/options.ts
@@ -54,7 +54,7 @@ export async function resolveOptions(options: Partial<VitePWAOptions>, viteConfi
     includeManifestIcons = true,
     useCredentials = false,
     disable = false,
-    devOptions = { enabled: false, type: 'classic' },
+    devOptions = { enabled: false, type: 'classic', suppressWarnings: false },
     selfDestroying = false,
     integration = {},
     buildBase,

diff --git a/src/plugins/dev.ts b/src/plugins/dev.ts
@@ -120,6 +120,15 @@ export function DevPlugin(ctx: PWAPluginContext) {
 
           const swDest = resolve(globDirectory, 'sw.js')
           if (!swDevOptions.swDevGenerated || !existsSync(swDest)) {
+            // add empty js file to suppress workbox-build warnings
+            let suppressWarnings: string | undefined
+            if (options.devOptions.suppressWarnings === true) {
+              suppressWarnings = normalizePath(resolve(globDirectory, 'suppress-warnings.js'))
+              await fs.writeFile(suppressWarnings, '', 'utf-8')
+            }
+            const globPatterns = options.devOptions.suppressWarnings === true
+              ? ['*.js']
+              : options.workbox.globPatterns
             // we only need to generate sw on dev-dist folder and then read the content
             // the sw precache (self.__SW_MANIFEST) will be empty since we're using `dev-dist` folder
             // we only need to add the navigateFallback if configured
@@ -134,11 +143,16 @@ export function DevPlugin(ctx: PWAPluginContext) {
                     ...options.workbox,
                     navigateFallbackAllowlist: options.devOptions.navigateFallbackAllowlist ?? [/^\/$/],
                     runtimeCaching: options.devOptions.disableRuntimeConfig ? undefined : options.workbox.runtimeCaching,
-                    // we only include navigateFallback
-                    additionalManifestEntries: navigateFallback ? [navigateFallback] : undefined,
+                    // we only include navigateFallback: add revision to remove workbox-build warning
+                    additionalManifestEntries: navigateFallback
+                      ? [{
+                          url: navigateFallback, revision: Math.random().toString(32),
+                        }]
+                      : undefined,
                     cleanupOutdatedCaches: true,
-                    globDirectory: globDirectory.replace(/\\/g, '/'),
-                    swDest: swDest.replace(/\\/g, '/'),
+                    globDirectory: normalizePath(globDirectory),
+                    globPatterns,
+                    swDest: normalizePath(swDest),
                   },
                 },
               ),
@@ -151,6 +165,12 @@ export function DevPlugin(ctx: PWAPluginContext) {
               if (name !== 'sw.js')
                 swDevOptions.workboxPaths.set(normalizePath(`${options.base}${name}`), we)
             })
+            if (suppressWarnings) {
+              swDevOptions.workboxPaths.set(
+                normalizePath(`${options.base}${basename(suppressWarnings)}`),
+                suppressWarnings,
+              )
+            }
             swDevOptions.swDevGenerated = true
           }
           return await fs.readFile(swDest, 'utf-8')

diff --git a/src/types.ts b/src/types.ts
@@ -465,6 +465,17 @@ export interface DevOptions {
    * Where to store generated service worker in development when using `generateSW` strategy.
    *
    * Use it with caution, it should be used only by framework integrations.
+   *
+   * @default resolve(viteConfig.root, 'dev-dist')
    */
   resolveTempFolder?: () => string | Promise<string>
+  /**
+   * Suppress workbox-build warnings?.
+   *
+   * **WARNING**: this option will only be used when using `generateSW` strategy.
+   * If enabled, `globPatterns` will be changed to `[*.js]` and a new empty `suppress-warnings.js` file will be created in .
+   *
+   * @default false
+   */
+  suppressWarnings?: boolean
 }