feat: migrate workbox-webpack-plugin to typescript (#2882)

* feat: migrate workbox-webpack-plugin to typescript * progress on typescript migration * 15e from ts lint * draft * fixing webpack version * running tests * running tests * eslint * passing tests for workbox webpack plugin * passing tests for wb wpp * passing tests for workbox webpack plugin passing tests for wb wpp cleaning imports * cleaning some eslint messages * keeping the checkConditions method signature for backward compatibility * fixing documentation * commiting package-lock * updating the webpack plugin package-lock * Fixing typescript typing issues Co-authored-by: Adriana Jara Salazar <ajara@google.com> Co-authored-by: Adriana Jara <32825533+tropicadri@users.noreply.github.com>
GoogleChrome · Feb 18, 2022 · 55e8144 · 55e8144
1 parent 10859de
commit 55e8144
Show file tree

Hide file tree

Showing 29 changed files with 32,741 additions and 467 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -123,6 +123,5 @@
     "test_node": "gulp test_node",
     "test_server": "gulp test_server",
     "version": "gulp build && git add -A packages"
-  },
-  "version": "0.0.0"
+  }
 }
diff --git a/packages/workbox-build/src/lib/populate-sw-template.ts b/packages/workbox-build/src/lib/populate-sw-template.ts
@@ -31,9 +31,9 @@ export function populateSWTemplate({
   offlineGoogleAnalytics,
   runtimeCaching = [],
   skipWaiting,
-}: GeneratePartial & {manifestEntries: Array<ManifestEntry>}): string {
+}: GeneratePartial & {manifestEntries?: Array<ManifestEntry>}): string {
   // There needs to be at least something to precache, or else runtime caching.
-  if (!(manifestEntries.length > 0 || runtimeCaching.length > 0)) {
+  if (!(manifestEntries?.length > 0 || runtimeCaching.length > 0)) {
     throw new Error(errors['no-manifest-entries-or-runtime-caching']);
   }
 

diff --git a/packages/workbox-build/src/schema/GenerateSWOptions.json b/packages/workbox-build/src/schema/GenerateSWOptions.json
@@ -467,11 +467,14 @@
     "QueueOptions": {
       "type": "object",
       "properties": {
-        "onSync": {
-          "$ref": "#/definitions/OnSyncCallback"
+        "forceSyncFallback": {
+          "type": "boolean"
         },
         "maxRetentionTime": {
           "type": "number"
+        },
+        "onSync": {
+          "$ref": "#/definitions/OnSyncCallback"
         }
       },
       "additionalProperties": false

diff --git a/packages/workbox-build/src/schema/GetManifestOptions.json b/packages/workbox-build/src/schema/GetManifestOptions.json
@@ -342,11 +342,14 @@
     "QueueOptions": {
       "type": "object",
       "properties": {
-        "onSync": {
-          "$ref": "#/definitions/OnSyncCallback"
+        "forceSyncFallback": {
+          "type": "boolean"
         },
         "maxRetentionTime": {
           "type": "number"
+        },
+        "onSync": {
+          "$ref": "#/definitions/OnSyncCallback"
         }
       },
       "additionalProperties": false

diff --git a/packages/workbox-build/src/schema/InjectManifestOptions.json b/packages/workbox-build/src/schema/InjectManifestOptions.json
@@ -357,11 +357,14 @@
     "QueueOptions": {
       "type": "object",
       "properties": {
-        "onSync": {
-          "$ref": "#/definitions/OnSyncCallback"
+        "forceSyncFallback": {
+          "type": "boolean"
         },
         "maxRetentionTime": {
           "type": "number"
+        },
+        "onSync": {
+          "$ref": "#/definitions/OnSyncCallback"
         }
       },
       "additionalProperties": false

diff --git a/packages/workbox-build/src/schema/WebpackGenerateSWOptions.json b/packages/workbox-build/src/schema/WebpackGenerateSWOptions.json
@@ -445,11 +445,14 @@
     "QueueOptions": {
       "type": "object",
       "properties": {
-        "onSync": {
-          "$ref": "#/definitions/OnSyncCallback"
+        "forceSyncFallback": {
+          "type": "boolean"
         },
         "maxRetentionTime": {
           "type": "number"
+        },
+        "onSync": {
+          "$ref": "#/definitions/OnSyncCallback"
         }
       },
       "additionalProperties": false

diff --git a/packages/workbox-build/src/schema/WebpackInjectManifestOptions.json b/packages/workbox-build/src/schema/WebpackInjectManifestOptions.json
@@ -345,11 +345,14 @@
     "QueueOptions": {
       "type": "object",
       "properties": {
-        "onSync": {
-          "$ref": "#/definitions/OnSyncCallback"
+        "forceSyncFallback": {
+          "type": "boolean"
         },
         "maxRetentionTime": {
           "type": "number"
+        },
+        "onSync": {
+          "$ref": "#/definitions/OnSyncCallback"
         }
       },
       "additionalProperties": false

diff --git a/packages/workbox-build/src/types.ts b/packages/workbox-build/src/types.ts
@@ -437,7 +437,8 @@ export interface WebpackPartial {
    * as `webpack`'s standard `exclude` option.
    * If not provided, the default value is `[/\.map$/, /^manifest.*\.js$]`.
    */
-  exclude?: Array<string | RegExp | ((arg0: string) => boolean)>;
+  //eslint-disable-next-line @typescript-eslint/ban-types
+  exclude?: Array<string | RegExp | ((arg0: any) => boolean)>;
   /**
    * One or more chunk names whose corresponding output files should be excluded
    * from the precache manifest.
@@ -449,7 +450,8 @@ export interface WebpackPartial {
    * [the same rules](https://webpack.js.org/configuration/module/#condition)
    * as `webpack`'s standard `include` option.
    */
-  include?: Array<string | RegExp | ((arg0: string) => boolean)>;
+  //eslint-disable-next-line @typescript-eslint/ban-types
+  include?: Array<string | RegExp | ((arg0: any) => boolean)>;
   /**
    * If set to 'production', then an optimized service worker bundle that
    * excludes debugging info will be produced. If not explicitly configured