[feature] configuration validation

bin/convert-argv.js

@@ -3,6 +3,10 @@ var fs = require("fs");
 fs.existsSync = fs.existsSync || path.existsSync;
 var interpret = require("interpret");
 var prepareOptions = require("./prepareOptions");
+var webpackConfigurationSchema = require("../schemas/webpackConfigurationSchema.json");
+var validateSchema = require("webpack").validateSchema;
+var WebpackOptionsValidationError = require("webpack").WebpackOptionsValidationError;
+
 module.exports = function(...args) {
 	var argv = args[1] || args[0];
 	var options = [];
@@ -148,10 +152,15 @@ module.exports = function(...args) {
 	}
 
 	function processConfiguredOptions(options) {
-		if (options === null || typeof options !== "object") {
-			console.error(
-				"Config did not export an object or a function returning an object."
+		var webpackConfigurationValidationErrors = validateSchema(
+			webpackConfigurationSchema,
+			options
+		);
+		if (webpackConfigurationValidationErrors.length) {
+			var error = new WebpackOptionsValidationError(
+				webpackConfigurationValidationErrors
 			);
+			console.error(error.message);
 			process.exit(-1); // eslint-disable-line
 		}
 

schemas/webpackConfigurationSchema.json

@@ -0,0 +1,20 @@
+{
+  "oneOf": [
+    {
+      "type": "object",
+      "description": "A webpack configuration object."
+    },
+    {
+      "type": "array",
+      "description": "An array of webpack configuration objects.",
+      "items": {
+        "description": "A webpack configuration object.",
+        "type": "object"
+      }
+    },
+    {
+      "instanceof": "Function",
+      "description": "A promise that resolves with a configuration object, or an array of configuration objects."
+    }
+  ]
+}

test/binCases/config-type/array/entry-a.js

@@ -0,0 +1 @@
+module.exports = "entry-a.js";

test/binCases/config-type/array/entry-b.js

@@ -0,0 +1 @@
+module.exports = "entry-b.js";

test/binCases/config-type/array/stdin.js

@@ -0,0 +1,13 @@
+"use strict";
+
+module.exports = function testAssertions(code, stdout, stderr) {
+	expect(code).toBe(0);
+	expect(stdout).toEqual(expect.anything());
+	expect(stdout[0]).toContain("Hash: ");
+	expect(stdout[1]).toContain("Version: ");
+	expect(stdout[2]).toContain("Child");
+	expect(stdout[6]).toContain("entry-a.bundle.js");
+	expect(stdout[8]).toContain("Child");
+	expect(stdout[12]).toContain("entry-b.bundle.js");
+	expect(stderr).toHaveLength(0);
+};

test/binCases/config-type/array/test.opts

@@ -0,0 +1,3 @@
+--config ./webpack.config.js
+--target async-node
+--mode production

test/binCases/config-type/array/webpack.config.js

@@ -0,0 +1,15 @@
+module.exports = [
+  {
+    entry: "./entry-a",
+    output: {
+      filename: "entry-a.bundle.js"
+    }
+  },
+  {
+    entry: "./entry-b",
+    output: {
+      filename: "entry-b.bundle.js"
+    }
+  }
+];
+

test/binCases/config-type/function-promise/entry.js

@@ -0,0 +1 @@
+module.exports = "entry.js";

test/binCases/config-type/function-promise/stdin.js

@@ -0,0 +1,11 @@
+"use strict";
+
+module.exports = function testAssertions(code, stdout, stderr) {
+	expect(code).toBe(0);
+	expect(stdout).toEqual(expect.anything());
+	expect(stdout[0]).toContain("Hash: ");
+	expect(stdout[1]).toContain("Version: ");
+	expect(stdout[2]).toContain("Time: ");
+	expect(stdout[4]).toContain("entry.bundle.js");
+	expect(stderr).toHaveLength(0);
+};

test/binCases/config-type/function-promise/test.opts

@@ -0,0 +1,3 @@
+--config ./webpack.config.js
+--target async-node
+--mode production

test/binCases/config-type/function-promise/webpack.config.js

@@ -0,0 +1,10 @@
+module.exports = (/*env*/) => {
+	return new Promise((resolve, reject) => {
+		resolve({
+			entry: "./entry",
+			output: {
+				filename: "entry.bundle.js"
+			}
+		})
+	});
+}

test/binCases/config-type/function/entry.js

@@ -0,0 +1 @@
+module.exports = "entry.js";

test/binCases/config-type/function/stdin.js

@@ -0,0 +1,11 @@
+"use strict";
+
+module.exports = function testAssertions(code, stdout, stderr) {
+	expect(code).toBe(0);
+	expect(stdout).toEqual(expect.anything());
+	expect(stdout[0]).toContain("Hash: ");
+	expect(stdout[1]).toContain("Version: ");
+	expect(stdout[2]).toContain("Time: ");
+	expect(stdout[4]).toContain("entry.bundle.js");
+	expect(stderr).toHaveLength(0);
+};

test/binCases/config-type/function/test.opts

@@ -0,0 +1,3 @@
+--config ./webpack.config.js
+--target async-node
+--mode production

test/binCases/config-type/function/webpack.config.js

@@ -0,0 +1,8 @@
+module.exports = function(env) {
+	return {
+		entry: "./entry",
+		output: {
+			filename: "entry.bundle.js"
+		}
+	};
+};

test/binCases/config-type/invalid-array/entry-a.js

@@ -0,0 +1 @@
+module.exports = "entry-a.js";

test/binCases/config-type/invalid-array/entry-b.js

@@ -0,0 +1 @@
+module.exports = "entry-b.js";

test/binCases/config-type/invalid-array/stdin.js

@@ -0,0 +1,7 @@
+"use strict";
+
+module.exports = function testAssertions(code, stdout, stderr) {
+	expect(code).not.toBe(0);
+	expect(stderr).toEqual(expect.anything());
+	expect(stderr[0]).toContain("Invalid configuration object. Webpack has been initialised using a configuration object that does not match the API schema.");
+};

test/binCases/config-type/invalid-array/test.opts

@@ -0,0 +1,3 @@
+--config ./webpack.config.js
+--target async-node
+--mode production

test/binCases/config-type/invalid-array/webpack.config.js

@@ -0,0 +1,16 @@
+module.exports = [
+  {
+    entry: "./entry-a",
+    output: {
+      filename: "entry-a.bundle.js"
+    }
+  },
+  "this string makes this array of configurations invalid.",
+  {
+    entry: "./entry-b",
+    output: {
+      filename: "entry-b.bundle.js"
+    }
+  }
+];
+

test/binCases/config-type/invalid-type/entry.js

@@ -0,0 +1 @@
+module.exports = "entry.js";

test/binCases/config-type/invalid-type/stdin.js

@@ -0,0 +1,7 @@
+"use strict";
+
+module.exports = function testAssertions(code, stdout, stderr) {
+	expect(code).not.toBe(0);
+	expect(stderr).toEqual(expect.anything());
+	expect(stderr[0]).toContain("Invalid configuration object. Webpack has been initialised using a configuration object that does not match the API schema.");
+};

test/binCases/config-type/invalid-type/test.opts

@@ -0,0 +1,3 @@
+--config ./webpack.config.js
+--target async-node
+--mode production

test/binCases/config-type/invalid-type/webpack.config.js

@@ -0,0 +1,2 @@
+module.exports = 100;
+

test/binCases/config-type/object/entry.js

@@ -0,0 +1 @@
+module.exports = "entry.js";

test/binCases/config-type/object/stdin.js

@@ -0,0 +1,11 @@
+"use strict";
+
+module.exports = function testAssertions(code, stdout, stderr) {
+	expect(code).toBe(0);
+	expect(stdout).toEqual(expect.anything());
+	expect(stdout[0]).toContain("Hash: ");
+	expect(stdout[1]).toContain("Version: ");
+	expect(stdout[2]).toContain("Time: ");
+	expect(stdout[4]).toContain("entry.bundle.js");
+	expect(stderr).toHaveLength(0);
+};

test/binCases/config-type/object/test.opts

@@ -0,0 +1,3 @@
+--config ./webpack.config.js
+--target async-node
+--mode production

test/binCases/config-type/object/webpack.config.js

@@ -0,0 +1,8 @@
+module.exports = function(env) {
+	return {
+		entry: "./entry",
+		output: {
+			filename: "entry.bundle.js"
+		}
+	};
+};

test/binCases/config-type/promise/entry.js

@@ -0,0 +1 @@
+module.exports = "entry.js";

test/binCases/config-type/promise/stdin.js

@@ -0,0 +1,11 @@
+"use strict";
+
+module.exports = function testAssertions(code, stdout, stderr) {
+	expect(code).toBe(0);
+	expect(stdout).toEqual(expect.anything());
+	expect(stdout[0]).toContain("Hash: ");
+	expect(stdout[1]).toContain("Version: ");
+	expect(stdout[2]).toContain("Time: ");
+	expect(stdout[4]).toContain("entry.bundle.js");
+	expect(stderr).toHaveLength(0);
+};

test/binCases/config-type/promise/test.opts

@@ -0,0 +1,3 @@
+--config ./webpack.config.js
+--target async-node
+--mode production

test/binCases/config-type/promise/webpack.config.js

@@ -0,0 +1,8 @@
+module.exports = new Promise((resolve, reject) => {
+	resolve({
+		entry: "./entry",
+		output: {
+			filename: "entry.bundle.js"
+		}
+	});
+});