Merge pull request webpack#1120 from kennyt/documentation

sokra · sokra · commit 6bc6fcd75add · 2015-06-15T09:24:11.000+02:00
Add argument error handling for optimization plugins
diff --git a/lib/optimize/AggressiveMergingPlugin.js b/lib/optimize/AggressiveMergingPlugin.js
@@ -3,6 +3,9 @@
 	Author Tobias Koppers @sokra
 */
 function AggressiveMergingPlugin(options) {
+	if(options !== undefined && typeof options !== "object" || Array.isArray(options)) {
+		throw new Error("Argument should be an options object. To use defaults, pass in nothing.\nFor more info on options, see http://webpack.github.io/docs/list-of-plugins.html");
+	}
 	this.options = options || {};
 }
 module.exports = AggressiveMergingPlugin;
diff --git a/lib/optimize/LimitChunkCountPlugin.js b/lib/optimize/LimitChunkCountPlugin.js
@@ -3,6 +3,9 @@
 	Author Tobias Koppers @sokra
 */
 function LimitChunkCountPlugin(options) {
+	if(options !== undefined && typeof options !== "object" || Array.isArray(options)) {
+		throw new Error("Argument should be an options object.\nFor more info on options, see http://webpack.github.io/docs/list-of-plugins.html");
+	}
 	this.options = options || {};
 }
 module.exports = LimitChunkCountPlugin;
diff --git a/lib/optimize/MinChunkSizePlugin.js b/lib/optimize/MinChunkSizePlugin.js
@@ -3,6 +3,9 @@
 	Author Tobias Koppers @sokra
 */
 function MinChunkSizePlugin(options) {
+	if(typeof options !== "object" || Array.isArray(options)) {
+		throw new Error("Argument should be an options object.\nFor more info on options, see http://webpack.github.io/docs/list-of-plugins.html");
+	}
 	this.options = options;
 }
 module.exports = MinChunkSizePlugin;
diff --git a/lib/optimize/OccurrenceOrderPlugin.js b/lib/optimize/OccurrenceOrderPlugin.js
@@ -3,6 +3,9 @@
 	Author Tobias Koppers @sokra
 */
 function OccurrenceOrderPlugin(preferEntry) {
+	if(preferEntry !== undefined && typeof preferEntry !== "boolean") {
+		throw new Error("Argument should be a boolean.\nFor more info on this plugin, see http://webpack.github.io/docs/list-of-plugins.html");
+	}
 	this.preferEntry = preferEntry;
 }
 module.exports = OccurrenceOrderPlugin;
diff --git a/test/Integration.test.js b/test/Integration.test.js
@@ -52,7 +52,7 @@ describe("Integration", function() {
 				alias: { should: require.resolve("should") }
 			},
 			plugins: [
-				new webpack.optimize.LimitChunkCountPlugin(1),
+				new webpack.optimize.LimitChunkCountPlugin({maxChunks: 1}),
 				new webpack.DefinePlugin({
 					"typeof CONST_TYPEOF": JSON.stringify("typeof"),
 					CONST_TRUE: true,
diff --git a/test/NodeTemplatePlugin.test.js b/test/NodeTemplatePlugin.test.js
@@ -50,7 +50,7 @@ describe("NodeTemplatePlugin", function() {
 			},
 			entry: "./entry",
 			plugins: [
-				new webpack.optimize.LimitChunkCountPlugin(1),
+				new webpack.optimize.LimitChunkCountPlugin({maxChunks: 1}),
 				new webpack.optimize.UglifyJsPlugin()
 			]
 		}, function(err, stats) {
diff --git a/test/browsertest/library2config.coffee b/test/browsertest/library2config.coffee
@@ -14,7 +14,8 @@ module.exports =
 		alias:
 			should: require.resolve "should"
 	plugins: [
-		new webpack.optimize.LimitChunkCountPlugin 2
+		new webpack.optimize.LimitChunkCountPlugin
+			maxChunks: 2
 		new webpack.DefinePlugin
 			"typeof CONST_TYPEOF": JSON.stringify("typeof"),
 			CONST_UNDEFINED: undefined,

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ describe("NodeTemplatePlugin", function() {`
`50`	`50`	`},`
`51`	`51`	`entry: "./entry",`
`52`	`52`	`plugins: [`
`53`		`- new webpack.optimize.LimitChunkCountPlugin(1),`
	`53`	`+ new webpack.optimize.LimitChunkCountPlugin({maxChunks: 1}),`
`54`	`54`	`new webpack.optimize.UglifyJsPlugin()`
`55`	`55`	`]`
`56`	`56`	`}, function(err, stats) {`