Improvement: add schema for profiling plugin options, remove todo item

EugeneHlushko · EugeneHlushko · commit fb4b275dc94a · 2018-02-13T19:13:07.000+02:00
diff --git a/lib/debug/ProfilingPlugin.js b/lib/debug/ProfilingPlugin.js
@@ -131,10 +131,12 @@ function createTrace(outPath) {
 }
 
 const pluginName = "ProfilingPlugin";
+const validateOptions = require("schema-utils");
+const schema = require("../../schemas/plugins/debug/ProfilingPlugin.json");
 
 class ProfilingPlugin {
-	// TODO: Add plugin schema validation here since there are options.
 	constructor(opts) {
+		validateOptions(schema, opts || {}, "Profiling plugin");
 		opts = opts || {};
 		this.outPath = opts.outPath || "events.json";
 	}
diff --git a/schemas/plugins/debug/ProfilingPlugin.json b/schemas/plugins/debug/ProfilingPlugin.json
@@ -0,0 +1,13 @@
+{
+  "id": "ProfilingPlugin",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "outPath": {
+      "description": "Path to the output file e.g. `profiling/events.json`. Defaults to `events.json`.",
+      "type": "string",
+      "absolutePath": true,
+      "minLength": 4
+    }
+  }
+}
diff --git a/schemas/plugins/optimize/CommonsChunkPlugin.json b/schemas/plugins/optimize/CommonsChunkPlugin.json

Original file line number	Diff line number	Diff line change
`@@ -131,10 +131,12 @@ function createTrace(outPath) {`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`const pluginName = "ProfilingPlugin";`
	`134`	`+const validateOptions = require("schema-utils");`
	`135`	`+const schema = require("../../schemas/plugins/debug/ProfilingPlugin.json");`
`134`	`136`
`135`	`137`	`class ProfilingPlugin {`
`136`		`- // TODO: Add plugin schema validation here since there are options.`
`137`	`138`	`constructor(opts) {`
	`139`	`+ validateOptions(schema, opts \|\| {}, "Profiling plugin");`
`138`	`140`	`opts = opts \|\| {};`
`139`	`141`	`this.outPath = opts.outPath \|\| "events.json";`
`140`	`142`	`}`