Merge pull request #358 from scottdj92/master

Update to include JSON schema and some validation

Author: bebraw

index.js

@@ -9,6 +9,7 @@ var ExtractedModule = require("./ExtractedModule");
 var Chunk = require("webpack/lib/Chunk");
 var OrderUndefinedError = require("./OrderUndefinedError");
 var loaderUtils = require("loader-utils");
+var schemaTester = require('./schema/validator');
 
 var NS = fs.realpathSync(__dirname);
 
@@ -118,6 +119,8 @@ function ExtractTextPlugin(options) {
 	}
 	if(isString(options)) {
 		options = { filename: options };
+	} else {
+		schemaTester(options);
 	}
 	this.filename = options.filename;
 	this.id = options.id != null ? options.id : ++nextId;
@@ -181,6 +184,8 @@ ExtractTextPlugin.prototype.extract = function(options) {
 	}
 	if(Array.isArray(options) || isString(options) || typeof options.options === "object" || typeof options.query === 'object') {
 		options = { loader: options };
+	} else {
+		schemaTester(options);
 	}
 	var loader = options.loader;
 	var before = options.fallbackLoader || [];

package.json

@@ -15,6 +15,7 @@
     "webpack-sources": "^0.1.0"
   },
   "devDependencies": {
+    "ajv": "^4.11.2",
     "codecov.io": "^0.1.2",
     "coveralls": "^2.11.2",
     "css-loader": "^0.26.1",

schema/schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "allChunks": {
+      "description": "",
+      "type": "boolean"
+    },
+    "disable": {
+      "description": "",
+      "type": "boolean"
+    },
+    "fallbackLoader": {
+      "description": "A loader that webpack can fall back to if the original one fails.",
+      "modes": {
+        "type": "string",
+        "type": "object",
+        "type": "array"
+      }
+    },
+    "filename": {
+      "description": "The filename and path that ExtractTextPlugin will extract to",
+      "type": "string"
+    },
+    "loader": {
+      "description": "The loader that ExtractTextPlugin will attempt to load through.",
+      "modes": {
+        "type": "string",
+        "type": "object",
+        "type": "array"
+      }
+    },
+    "publicPath": {
+      "description": "",
+      "type": "string"
+    }
+  }
+}

schema/valid.json

@@ -0,0 +1,8 @@
+{
+  "allChunks": { "type": "boolean"},
+  "disable": { "type": "boolean" },
+  "fallbackLoader": { "type": "string" },
+  "filename": { "type": "string" },
+  "loader": { "type": "string" },
+  "publicPath": { "type": "string" }
+}

schema/validator.js

@@ -0,0 +1,12 @@
+var Ajv = require('ajv');
+var ajv = new Ajv({allErrors: true});
+var json = require('./schema.json');
+
+module.exports = function validate(data) {
+	var validSchema = ajv.compile(json);
+	var valid = validSchema(data);
+
+	if(!valid) {
+		throw new Error(ajv.errorsText());
+	}
+}

test/extract.test.js

@@ -10,6 +10,26 @@ describe("ExtractTextPlugin.extract()", function() {
 		});
 	});
 
+	context("json schema validation", function() {
+		it("does not throw if a filename is specified", function() {
+			should.doesNotThrow(function() {
+				ExtractTextPlugin.extract("file.css");
+			});
+		});
+
+		it("does not throw if a correct config object is passed in", function() {
+			should.doesNotThrow(function() {
+				ExtractTextPlugin.extract({loader: 'css-loader'});
+			});
+		});
+
+		it("throws if an incorrect config is passed in", function() {
+			should.throws(function() {
+				ExtractTextPlugin.extract({style: 'file.css'});
+			});
+		});
+	});
+
 	context("specifying loader", function() {
 		it("accepts a loader string", function() {
 			ExtractTextPlugin.extract("css-loader").should.deepEqual([