feat: added the keep-source-maps value to the `deleteOriginalAssets…

…` option (#216)
webpack-contrib · Nov 9, 2020 · bd60650 · bd60650
1 parent 37b53e7
commit bd60650
Show file tree

Hide file tree

Showing 20 changed files with 366 additions and 239 deletions.
diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@ And run `webpack` via your preferred method.
 |            **[`threshold`](#threshold)**            |                `{Number}`                 |                              `0`                              | Only assets bigger than this size are processed (in bytes)                                                    |
 |             **[`minRatio`](#minratio)**             |                `{Number}`                 |                             `0.8`                             | Only assets that compress better than this ratio are processed (`minRatio = Compressed Size / Original Size`) |
 |             **[`filename`](#filename)**             |           `{String\|Function}`            |                       `[path][base].gz`                       | The target asset filename                                                                                     |
-| **[`deleteOriginalAssets`](#deleteoriginalassets)** |                `{Boolean}`                |                            `false`                            | Whether to delete the original assets or not                                                                  |
+| **[`deleteOriginalAssets`](#deleteoriginalassets)** |      `{Boolean\|'keep-source-map'}`       |                            `false`                            | Whether to delete the original assets or not                                                                  |
 |                **[`cache`](#cache)**                |                `{Boolean}`                |                            `true`                             | Enable file caching                                                                                           |
 
 ### `test`
@@ -289,7 +289,7 @@ module.exports = {
 
 ### `deleteOriginalAssets`
 
-Type: `Boolean`
+Type: `Boolean | 'keep-source-map'`
 Default: `false`
 
 Whether to delete the original assets or not.
@@ -306,6 +306,19 @@ module.exports = {
 };
 ```
 
+To exclude sourcemaps from compression
+
+```js
+module.exports = {
+  plugins: [
+    new CompressionPlugin({
+      exclude: /.map$/
+      deleteOriginalAssets: 'keep-source-map',
+    }),
+  ],
+};
+```
+
 ### `cache`
 
 > ⚠ Ignored in webpack 5! Please use https://webpack.js.org/configuration/other-options/#cache.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -71,7 +71,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.1.2",
     "standard-version": "^9.0.0",
-    "webpack": "^5.3.2"
+    "webpack": "^5.4.0"
   },
   "keywords": [
     "webpack"

diff --git a/src/index.js b/src/index.js
@@ -299,7 +299,21 @@ class CompressionPlugin {
           }
 
           if (this.options.deleteOriginalAssets) {
-            // eslint-disable-next-line no-param-reassign
+            if (this.options.deleteOriginalAssets === 'keep-source-map') {
+              // TODO `...` required only for webpack@4
+              const updatedAssetInfo = {
+                ...info,
+                related: { ...info.related, sourceMap: null },
+              };
+
+              CompressionPlugin.updateAsset(
+                compilation,
+                name,
+                inputSource,
+                updatedAssetInfo
+              );
+            }
+
             CompressionPlugin.deleteAsset(compilation, name);
           } else {
             // TODO `...` required only for webpack@4

diff --git a/src/options.json b/src/options.json
@@ -85,7 +85,15 @@
     },
     "deleteOriginalAssets": {
       "description": "Whether to delete the original assets or not.",
-      "type": "boolean"
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "string",
+          "enum": ["keep-source-map"]
+        }
+      ]
     },
     "filename": {
       "description": "The target asset filename.",