add better validation for options, rename async to prevent future clash with reserved words

timse · timse · commit c97b3de91246 · 2017-02-21T23:47:54.000+11:00
diff --git a/lib/optimize/CommonsChunkPlugin.js b/lib/optimize/CommonsChunkPlugin.js
@@ -48,23 +48,35 @@ The available options are:
 			};
 		}
 
-		// if "children" is set, set selectedChunks to false instead of specified chunks
-		// TODO: why? :P
-		const selectedChunks = options.children ? false : options.chunks;
+		// options.children and options.chunk may not be used together
+		if(options.children && options.chunks) {
+			throw new Error("You can't and it does not make any sense to use \"children\" and \"chunk\" options together.");
+		}
+
+		/**
+		 * options.async and options.filename are also not possible together
+		 * as filename specifies how the chunk is called but "async" implies
+		 * that webpack will take care of loading this file.
+		 */
+		if(options.async && options.filename) {
+			throw new Error("If you set the \"async\" option webpack takes care of loading the chunk. Therefore you can not specify a filename.");
+		}
+
 		const chunkNames = options.name ? [options.name] : options.names;
 		return {
 			chunkNames: chunkNames,
 			filenameTemplate: options.filename,
 			minChunks: options.minChunks,
-			selectedChunks: selectedChunks,
+			selectedChunks: options.chunks,
+			children: options.children,
 			async: options.async,
 			minSize: options.minSize,
 			ident: __filename + (nextIdent++),
 		};
 	}
 
-	getCommonChunks(allChunks, compilation, chunkNames, selectedChunks, async) {
-		const asyncOrNoSelectedChunk = selectedChunks === false || async;
+	getCommonChunks(allChunks, compilation, chunkNames, selectedChunks, asyncOption) {
+		const asyncOrNoSelectedChunk = selectedChunks === false || asyncOption;
 
 		// we have specified chunk names
 		if(chunkNames) {
@@ -94,8 +106,8 @@ The available options are:
 		throw new Error("Invalid chunkNames argument");
 	}
 
-	getUsedChunks(compilation, allChunks, commonChunk, commonChunks, currentIndex, selectedChunks, isAsync) {
-		const asyncOrNoSelectedChunk = selectedChunks === false || isAsync;
+	getUsedChunks(compilation, allChunks, commonChunk, commonChunks, currentIndex, selectedChunks, asyncOption) {
+		const asyncOrNoSelectedChunk = selectedChunks === false || asyncOption;
 
 		if(Array.isArray(selectedChunks)) {
 			return allChunks.filter(chunk => {
@@ -113,7 +125,7 @@ The available options are:
 
 			return commonChunk.chunks.filter((chunk) => {
 				// we can only move modules from this chunk if the "commonChunk" is the only parent
-				return isAsync || chunk.parents.length === 1;
+				return asyncOption || chunk.parents.length === 1;
 			});
 		}
 
