Accept undefined and null in plugins

silverwind · silverwind · commit 792de0e6a44f · 2023-06-05T23:53:36.000+02:00
diff --git a/declarations/WebpackOptions.d.ts b/declarations/WebpackOptions.d.ts
@@ -596,7 +596,7 @@ export type Performance = false | PerformanceOptions;
 /**
  * Add additional plugins to the compiler.
  */
-export type Plugins = (WebpackPluginInstance | WebpackPluginFunction)[];
+export type Plugins = (null | WebpackPluginInstance | WebpackPluginFunction)[];
 /**
  * Capture timing information for each module.
  */
diff --git a/lib/Compiler.js b/lib/Compiler.js
@@ -1073,7 +1073,9 @@ ${other}`);
 		childCompiler.root = this.root;
 		if (Array.isArray(plugins)) {
 			for (const plugin of plugins) {
-				plugin.apply(childCompiler);
+				if ("apply" in plugin) {
+					plugin.apply(childCompiler);
+				}
 			}
 		}
 		for (const name in this.hooks) {
diff --git a/lib/rules/RuleSetCompiler.js b/lib/rules/RuleSetCompiler.js
@@ -54,7 +54,9 @@ class RuleSetCompiler {
 		});
 		if (plugins) {
 			for (const plugin of plugins) {
-				plugin.apply(this);
+				if ("apply" in plugin) {
+					plugin.apply(this);
+				}
 			}
 		}
 	}
diff --git a/lib/webpack.js b/lib/webpack.js
@@ -69,7 +69,7 @@ const createCompiler = rawOptions => {
 		for (const plugin of options.plugins) {
 			if (typeof plugin === "function") {
 				plugin.call(compiler, compiler);
-			} else {
+			} else if ("apply" in plugin) {
 				plugin.apply(compiler);
 			}
 		}
diff --git a/schemas/WebpackOptions.check.js b/schemas/WebpackOptions.check.js
diff --git a/schemas/WebpackOptions.json b/schemas/WebpackOptions.json
@@ -3561,6 +3561,9 @@
       "items": {
         "description": "Plugin of type object or instanceof Function.",
         "anyOf": [
+          {
+            "type": "null"
+          },
           {
             "$ref": "#/definitions/WebpackPluginInstance"
           },
diff --git a/test/Validation.test.js b/test/Validation.test.js
@@ -315,9 +315,10 @@ describe("Validation", () => {
 			expect(msg).toMatchInlineSnapshot(`
 			"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
 			 - configuration.plugins[0] should be one of these:
-			   object { apply, … } | function
+			   null | object { apply, … } | function
 			   -> Plugin of type object or instanceof Function.
 			   Details:
+			    * configuration.plugins[0] should be a null.
 			    * configuration.plugins[0] should be an object:
 			      object { apply, … }
 			      -> Plugin instance.
@@ -336,9 +337,10 @@ describe("Validation", () => {
 			expect(msg).toMatchInlineSnapshot(`
 			"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
 			 - configuration.plugins[0] should be one of these:
-			   object { apply, … } | function
+			   null | object { apply, … } | function
 			   -> Plugin of type object or instanceof Function.
 			   Details:
+			    * configuration.plugins[0] should be a null.
 			    * configuration.plugins[0] should be an object:
 			      object { apply, … }
 			      -> Plugin instance.
@@ -357,9 +359,10 @@ describe("Validation", () => {
 			expect(msg).toMatchInlineSnapshot(`
 			"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
 			 - configuration.plugins[0] should be one of these:
-			   object { apply, … } | function
+			   null | object { apply, … } | function
 			   -> Plugin of type object or instanceof Function.
 			   Details:
+			    * configuration.plugins[0] should be a null.
 			    * configuration.plugins[0] should be an object:
 			      object { apply, … }
 			      -> Plugin instance.
@@ -378,9 +381,10 @@ describe("Validation", () => {
 			expect(msg).toMatchInlineSnapshot(`
 			"Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
 			 - configuration.plugins[0] should be one of these:
-			   object { apply, … } | function
+			   null | object { apply, … } | function
 			   -> Plugin of type object or instanceof Function.
 			   Details:
+			    * configuration.plugins[0] should be a null.
 			    * configuration.plugins[0] should be an object:
 			      object { apply, … }
 			      -> Plugin instance.
diff --git a/test/configCases/plugins/null-undefined/index.js b/test/configCases/plugins/null-undefined/index.js
@@ -0,0 +1,3 @@
+it("should accept null and undefined as plugins and define TRUE", function() {
+	expect(TRUE).toBe(true);
+});
diff --git a/test/configCases/plugins/null-undefined/webpack.config.js b/test/configCases/plugins/null-undefined/webpack.config.js
@@ -0,0 +1,12 @@
+var DefinePlugin = require("../../../../").DefinePlugin;
+
+/** @type {import("../../../../").Configuration[]} */
+module.exports = {
+	plugins: [
+		null,
+		undefined,
+		new DefinePlugin({
+			TRUE: true
+		})
+	]
+};
diff --git a/types.d.ts b/types.d.ts
@@ -2378,6 +2378,7 @@ declare interface Configuration {
 	 * Add additional plugins to the compiler.
 	 */
 	plugins?: (
+		| null
 		| ((this: Compiler, compiler: Compiler) => void)
 		| WebpackPluginInstance
 	)[];
@@ -13149,6 +13150,7 @@ declare interface WebpackOptionsNormalized {
 	 * Add additional plugins to the compiler.
 	 */
 	plugins: (
+		| null
 		| ((this: Compiler, compiler: Compiler) => void)
 		| WebpackPluginInstance
 	)[];

Original file line number	Diff line number	Diff line change
@@ -1073,7 +1073,9 @@ ${other}`);
`1073`	`1073`	`childCompiler.root = this.root;`
`1074`	`1074`	`if (Array.isArray(plugins)) {`
`1075`	`1075`	`for (const plugin of plugins) {`
`1076`		`- plugin.apply(childCompiler);`
	`1076`	`+ if ("apply" in plugin) {`
	`1077`	`+ plugin.apply(childCompiler);`
	`1078`	`+ }`
`1077`	`1079`	`}`
`1078`	`1080`	`}`
`1079`	`1081`	`for (const name in this.hooks) {`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,9 @@ class RuleSetCompiler {`
`54`	`54`	`});`
`55`	`55`	`if (plugins) {`
`56`	`56`	`for (const plugin of plugins) {`
`57`		`- plugin.apply(this);`
	`57`	`+ if ("apply" in plugin) {`
	`58`	`+ plugin.apply(this);`
	`59`	`+ }`
`58`	`60`	`}`
`59`	`61`	`}`
`60`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ const createCompiler = rawOptions => {`
`69`	`69`	`for (const plugin of options.plugins) {`
`70`	`70`	`if (typeof plugin === "function") {`
`71`	`71`	`plugin.call(compiler, compiler);`
`72`		`- } else {`
	`72`	`+ } else if ("apply" in plugin) {`
`73`	`73`	`plugin.apply(compiler);`
`74`	`74`	`}`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+it("should accept null and undefined as plugins and define TRUE", function() {`
	`2`	`+ expect(TRUE).toBe(true);`
	`3`	`+});`