feat: improve naming of extracted file with comments (#154)

webpack-contrib · Sep 12, 2019 · 5fe3337 · 5fe3337
1 parent cea7243
commit 5fe3337
Show file tree

Hide file tree

Showing 4 changed files with 332 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -489,8 +489,11 @@ module.exports = {
       new TerserPlugin({
         extractComments: {
           condition: /^\**!|@preserve|@license|@cc_on/i,
-          filename: (file) => {
-            return `${file}.LICENSE`;
+          filename: (file, fileData) => {
+            // A file can contain a query string (for example when you have `output.filename: '[name].js?[chunkhash]'`)
+            // You must consider this
+            // The "fileData" argument contains object with "filename", "basename", "query"
+            return file.replace(/\.(\w+)($|\?)/, '.$1.LICENSE$2');
           },
           banner: (licenseFile) => {
             return `License information can be found in ${licenseFile}`;
@@ -518,8 +521,10 @@ module.exports = {
       new TerserPlugin({
         extractComments: {
           condition: 'some',
-          filename: (file) => {
-            return `${file}.LICENSE`;
+          filename: (file, fileData) => {
+            // 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$2');
           },
           banner: (licenseFile) => {
             return `License information can be found in ${licenseFile}`;
@@ -534,7 +539,9 @@ module.exports = {
 ##### `filename`
 
 Type: `String|Function<(string) -> String>`
-Default: `${file}.LICENSE`
+Default: `[file].LICENSE[query]`
+
+Available placeholders: `[file]`, `[query]` and `[filebase]`.
 
 The file where the extracted comments will be stored.
 Default is to append the suffix `.LICENSE` to the original filename.
@@ -579,8 +586,10 @@ module.exports = {
       new TerserPlugin({
         extractComments: {
           condition: true,
-          filename: (file) => {
-            return `${file}.LICENSE`;
+          filename: (file, fileData) => {
+            // 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$2');
           },
           banner: (commentsFile) => {
             return `My custom banner about license information ${commentsFile}`;

diff --git a/src/index.js b/src/index.js
@@ -216,11 +216,34 @@ class TerserPlugin {
 
             if (this.options.extractComments) {
               commentsFile =
-                this.options.extractComments.filename || `${file}.LICENSE`;
+                this.options.extractComments.filename ||
+                '[file].LICENSE[query]';
 
+              // Todo remove this in next major release
               if (typeof commentsFile === 'function') {
-                commentsFile = commentsFile(file);
+                commentsFile = commentsFile.bind(null, file);
               }
+
+              let query = '';
+              let filename = file;
+
+              const querySplit = filename.indexOf('?');
+
+              if (querySplit >= 0) {
+                query = filename.substr(querySplit);
+                filename = filename.substr(0, querySplit);
+              }
+
+              const lastSlashIndex = filename.lastIndexOf('/');
+
+              const basename =
+                lastSlashIndex === -1
+                  ? filename
+                  : filename.substr(lastSlashIndex + 1);
+
+              const data = { filename, basename, query };
+
+              commentsFile = compilation.getPath(commentsFile, data);
             }
 
             const task = {