feat(plugin-pwa): improve types definition

vuepress · Jun 5, 2022 · e7590f4 · e7590f4
1 parent 07fbe43
commit e7590f4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/packages/@vuepress/plugin-pwa/src/node/generateServiceWorker.ts b/packages/@vuepress/plugin-pwa/src/node/generateServiceWorker.ts
@@ -1,6 +1,6 @@
 import type { App } from '@vuepress/core'
 import { logger } from '@vuepress/utils'
-import type { generateSW as GenerateSWFunc } from 'workbox-build'
+import type { GenerateSWOptions } from 'workbox-build'
 
 const assetsExtensions = [
   // basic
@@ -21,15 +21,18 @@ const assetsExtensions = [
   'otf',
 ]
 
+export type GenerateSWConfig = Omit<
+  GenerateSWOptions,
+  'swDest' | 'globDirectory'
+>
+
 export const generateServiceWorker = async (
   app: App,
   serviceWorkerFilename: string,
-  generateSWConfig: Partial<Parameters<typeof GenerateSWFunc>[0]>
+  generateSWConfig: GenerateSWConfig
 ): Promise<void> => {
   // lazy-load workbox-build
-  const { generateSW } = require('workbox-build') as {
-    generateSW: typeof GenerateSWFunc
-  }
+  const { generateSW } = await import('workbox-build')
 
   const globDirectory = app.dir.dest()
   const swDest = app.dir.dest(serviceWorkerFilename)

diff --git a/packages/@vuepress/plugin-pwa/src/node/pwaPlugin.ts b/packages/@vuepress/plugin-pwa/src/node/pwaPlugin.ts
@@ -1,13 +1,12 @@
 import type { Plugin, PluginObject } from '@vuepress/core'
 import { path, withSpinner } from '@vuepress/utils'
 import { generateServiceWorker } from './generateServiceWorker'
+import type { GenerateSWConfig } from './generateServiceWorker'
 
 /**
  * Options for @vuepress/plugin-pwa
  */
-export interface PwaPluginOptions
-  // TODO: the type of the parameter of generateSW is missing
-  extends Omit<any, 'swDest' | 'globDirectory'> {
+export interface PwaPluginOptions extends GenerateSWConfig {
   /**
    * Filename of the generated service worker file
    *