refactor: extractComments.filename option

BREAKING CHANGE: if the value from the `extractComments.filename` option conflicts with existing assets, an error will be thrown instead of a warning
webpack-contrib · Apr 30, 2020 · 974bc19 · 974bc19
1 parent d509135
commit 974bc19
Show file tree

Hide file tree

Showing 5 changed files with 1,137 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -523,12 +523,9 @@ module.exports = {
       new TerserPlugin({
         extractComments: {
           condition: 'some',
-          filename: (file, fileData) => {
-            // ⚠ webpack 5: there is only fileData parameter
-
-            // A file can contain a query string (for example when you have `output.filename: '[name].js?[chunkhash]'`)
-            // You must consider this
-            return file.replace(/\.(\w+)($|\?)/, '.$1.LICENSE.txt$2');
+          filename: (fileData) => {
+            // The "fileData" argument contains object with "filename", "basename", "query" and "hash"
+            return `${fileData.filename}.LICENSE.txt${fileData.query}`;
           },
           banner: (licenseFile) => {
             return `License information can be found in ${licenseFile}`;
@@ -590,12 +587,9 @@ module.exports = {
       new TerserPlugin({
         extractComments: {
           condition: true,
-          filename: (file, fileData) => {
-            // ⚠ webpack 5: there is only fileData parameter
-
-            // A file can contain a query string (for example when you have `output.filename: '[name].js?[chunkhash]'`)
-            // You must consider this
-            return file.replace(/\.(\w+)($|\?)/, '.$1.LICENSE.txt$2');
+          filename: (fileData) => {
+            // The "fileData" argument contains object with "filename", "basename", "query" and "hash"
+            return `${fileData.filename}.LICENSE.txt${fileData.query}`;
           },
           banner: (commentsFile) => {
             return `My custom banner about license information ${commentsFile}`;

diff --git a/src/index.js b/src/index.js
@@ -256,20 +256,18 @@ class TerserPlugin {
         const data = { filename, basename, query };
 
         commentsFilename = compilation.getPath(commentsFilename, data);
-      }
 
-      if (
-        commentsFilename &&
-        TerserPlugin.hasAsset(commentsFilename, compilation.assets)
-      ) {
-        // Todo make error and stop uglifing in next major release
-        compilation.warnings.push(
-          new Error(
-            `The comment file "${TerserPlugin.removeQueryString(
-              commentsFilename
-            )}" conflicts with an existing asset, this may lead to code corruption, please use a different name`
-          )
-        );
+        if (TerserPlugin.hasAsset(commentsFilename, compilation.assets)) {
+          compilation.errors.push(
+            new Error(
+              `The comment file "${TerserPlugin.removeQueryString(
+                commentsFilename
+              )}" conflicts with an existing asset, this may lead to code corruption, please use a different name`
+            )
+          );
+
+          yield false;
+        }
       }
 
       const callback = (taskResult) => {