special error message for custom properties in configuration

sokra · sokra · commit 7f31a4958168 · 2016-09-20T20:18:52.000+02:00
diff --git a/lib/WebpackOptionsValidationError.js b/lib/WebpackOptionsValidationError.js
@@ -24,8 +24,23 @@ WebpackOptionsValidationError.formatValidationError = function formatValidationE
 	var dataPath = "configuration" + err.dataPath;
 	switch(err.keyword) {
 		case "additionalProperties":
-			return dataPath + " has an unknown property '" + err.params.additionalProperty + "'. These properties are valid:\n" +
+			var baseMessage = dataPath + " has an unknown property '" + err.params.additionalProperty + "'. These properties are valid:\n" +
 				getSchemaPartText(err.parentSchema);
+			if(!err.dataPath) {
+				return baseMessage + "\n" +
+					"For typos: please correct them.\n" +
+					"For loader options: webpack 2 no longer allows custom properties in configuration.\n" +
+					"  Loaders should be updated to allow passing options via loader options in module.rules.\n" +
+					"  Until loaders are updated one can use the LoaderOptionsPlugin to pass these options to the loader:\n" +
+					"  plugins: {\n" +
+					"    new webpack.LoaderOptionsPlugin({\n" +
+					"      options: {\n" +
+					"        " + err.params.additionalProperty + ": ...\n" +
+					"      }\n" +
+					"    })\n" +
+					"  }";
+			}
+			return baseMessage;
 		case "oneOf":
 		case "anyOf":
 		case "enum":
diff --git a/test/Validation.test.js b/test/Validation.test.js
@@ -84,6 +84,27 @@ describe("Validation", function() {
 			" - configuration.module.rules[0].oneOf[0] has an unknown property 'paser'. These properties are valid:",
 			"   object { enforce?, exclude?, include?, issuer?, loader?, loaders?, oneOf?, options?, parser?, query?, resource?, rules?, test?, use? }"
 		]
+	}, {
+		name: "additional key on root",
+		config: {
+			entry: "a",
+			postcss: function() {}
+		},
+		message: [
+			" - configuration has an unknown property 'postcss'. These properties are valid:",
+			"   object { amd?, bail?, cache?, context?, dependencies?, devServer?, devtool?, entry, externals?, loader?, module?, name?, node?, output?, plugins?, profile?, recordsInputPath?, recordsOutputPath?, recordsPath?, resolve?, resolveLoader?, stats?, target?, watch?, watchOptions? }",
+			"   For typos: please correct them.",
+			"   For loader options: webpack 2 no longer allows custom properties in configuration.",
+			"     Loaders should be updated to allow passing options via loader options in module.rules.",
+			"     Until loaders are updated one can use the LoaderOptionsPlugin to pass these options to the loader:",
+			"     plugins: {",
+			"       new webpack.LoaderOptionsPlugin({",
+			"         options: {",
+			"           postcss: ...",
+			"         }",
+			"       })",
+			"     }"
+		]
 	}];
 	testCases.forEach(function(testCase) {
 		it("should fail validation for " + testCase.name, function() {
