allow to configure filename for splitted chunks

sokra · sokra · commit ecb65aa75a7c · 2018-03-02T10:14:25.000+01:00
webpack#6598
diff --git a/lib/JavascriptModulesPlugin.js b/lib/JavascriptModulesPlugin.js
@@ -100,7 +100,10 @@ class JavascriptModulesPlugin {
 						const moduleTemplates = options.moduleTemplates;
 						const dependencyTemplates = options.dependencyTemplates;
 
-						const filenameTemplate = outputOptions.chunkFilename;
+						let filenameTemplate;
+						if (chunk.filenameTemplate)
+							filenameTemplate = chunk.filenameTemplate;
+						else filenameTemplate = outputOptions.chunkFilename;
 
 						result.push({
 							render: () =>
diff --git a/lib/optimize/SplitChunksPlugin.js b/lib/optimize/SplitChunksPlugin.js
@@ -91,6 +91,7 @@ module.exports = class SplitChunksPlugin {
 			maxAsyncRequests: options.maxAsyncRequests || 1,
 			maxInitialRequests: options.maxInitialRequests || 1,
 			getName: SplitChunksPlugin.normalizeName(options.name) || (() => {}),
+			filename: options.filename || undefined,
 			getCacheGroups: SplitChunksPlugin.normalizeCacheGroups(
 				options.cacheGroups
 			)
@@ -169,6 +170,7 @@ module.exports = class SplitChunksPlugin {
 							minChunks: option.minChunks,
 							maxAsyncRequests: option.maxAsyncRequests,
 							maxInitialRequests: option.maxInitialRequests,
+							filename: option.filename,
 							reuseExistingChunk: option.reuseExistingChunk
 						});
 					}
@@ -277,6 +279,10 @@ module.exports = class SplitChunksPlugin {
 									cacheGroupSource.getName !== undefined
 										? cacheGroupSource.getName
 										: this.options.getName,
+								filename:
+									cacheGroupSource.filename !== undefined
+										? cacheGroupSource.filename
+										: this.options.filename,
 								reuseExistingChunk: cacheGroupSource.reuseExistingChunk
 							};
 							// For all combination of chunk selection
@@ -439,6 +445,17 @@ module.exports = class SplitChunksPlugin {
 									newChunk.entryModule = undefined;
 								}
 							}
+							if (item.cacheGroup.filename) {
+								if (!newChunk.isOnlyInitial()) {
+									throw new Error(
+										"SplitChunksPlugin: You are trying to set a filename for a chunk which is (also) loaded on demand. " +
+											"The runtime can only handle loading of chunks which match the chunkFilename schema. " +
+											"Using a custom filename would fail at runtime. " +
+											`(cache group: ${item.cacheGroup.key})`
+									);
+								}
+								newChunk.filenameTemplate = item.cacheGroup.filename;
+							}
 							if (!isReused) {
 								// Add all modules to the new chunk
 								for (const module of item.modules) {
diff --git a/schemas/WebpackOptions.json b/schemas/WebpackOptions.json
@@ -1377,6 +1377,11 @@
                     }
                   ]
                 },
+                "filename": {
+                  "description": "Sets the template for the filename for created chunks (Only works for initial chunks)",
+                  "type": "string",
+                  "minLength": 1
+                },
                 "cacheGroups": {
                   "description": "Assign modules to a cache group (modules from different cache groups are tried to keep in separate chunks)",
                   "type": "object",
@@ -1468,6 +1473,11 @@
                                 "type": "string"
                               }
                             ]
+                          },
+                          "filename": {
+                            "description": "Sets the template for the filename for created chunks (Only works for initial chunks)",
+                            "type": "string",
+                            "minLength": 1
                           }
                         }
                       }
diff --git a/test/configCases/filename-template/split-chunks-filename/index.js b/test/configCases/filename-template/split-chunks-filename/index.js
@@ -0,0 +1,9 @@
+it("should create a vendor file", function() {
+	var fs = require("fs");
+	var path = require("path");
+	if(!fs.existsSync(path.join(__dirname, "vendor.js")))
+		throw new Error("vendor.js file was not created");
+});
+
+require.include("test");
+
diff --git a/test/configCases/filename-template/split-chunks-filename/node_modules/test.js b/test/configCases/filename-template/split-chunks-filename/node_modules/test.js
diff --git a/test/configCases/filename-template/split-chunks-filename/webpack.config.js b/test/configCases/filename-template/split-chunks-filename/webpack.config.js
@@ -0,0 +1,19 @@
+module.exports = {
+	mode: "development",
+	node: {
+		__dirname: false,
+		__filename: false
+	},
+	optimization: {
+		splitChunks: {
+			cacheGroups: {
+				vendor: {
+					test: /node_modules/,
+					chunks: "initial",
+					filename: "vendor.js",
+					enforce: true
+				}
+			}
+		}
+	}
+};

Original file line number	Diff line number	Diff line change
`@@ -1377,6 +1377,11 @@`
`1377`	`1377`	`}`
`1378`	`1378`	`]`
`1379`	`1379`	`},`
	`1380`	`+ "filename": {`
	`1381`	`+ "description": "Sets the template for the filename for created chunks (Only works for initial chunks)",`
	`1382`	`+ "type": "string",`
	`1383`	`+ "minLength": 1`
	`1384`	`+ },`
`1380`	`1385`	`"cacheGroups": {`
`1381`	`1386`	`"description": "Assign modules to a cache group (modules from different cache groups are tried to keep in separate chunks)",`
`1382`	`1387`	`"type": "object",`
`@@ -1468,6 +1473,11 @@`
`1468`	`1473`	`"type": "string"`
`1469`	`1474`	`}`
`1470`	`1475`	`]`
	`1476`	`+ },`
	`1477`	`+ "filename": {`
	`1478`	`+ "description": "Sets the template for the filename for created chunks (Only works for initial chunks)",`
	`1479`	`+ "type": "string",`
	`1480`	`+ "minLength": 1`
`1471`	`1481`	`}`
`1472`	`1482`	`}`
`1473`	`1483`	`}`