add schema descriptions, comments

Author: waldronmatt

README.md

@@ -43,7 +43,7 @@ module.exports = {
 
 ## Options
 
-You can pass select [html-validate.org](https://html-validate.org/) cli options.
+You can pass select [html-validate.org cli options](https://html-validate.org/usage/cli.html).
 
 ### `path`
 

index.js

@@ -4,7 +4,7 @@ const schema = require('./schema.json');
 
 class HTMLValidatePlugin {
   constructor(options = {}) {
-    // validate the options being passed through the plugin options
+    // validate options being passed through the plugin
     validateOptions(schema, options, 'HTMLValidatePlugin');
 
     Object.assign(
@@ -62,10 +62,7 @@ class HTMLValidatePlugin {
     compiler.hooks.done.tap('HTMLValidatePlugin', () => {
       // set up cli payload
       const userParams = `${this.path}.${this.getExtensions()} ${this.getConfig()}`;
-      const spawnParams = {
-        shell: true,
-        /*inherit color output */ stdio: 'inherit',
-      };
+      const spawnParams = { shell: true, stdio: 'inherit' };
 
       this.runCliBasedOnScope(userParams, spawnParams);
     });

schema.json

@@ -2,15 +2,19 @@
   "type": "object",
   "properties": {
     "path": {
+      "description": "Specifies the directories/files for html-validate to search.",
       "type": "string"
     },
     "extensions": {
+      "description": "Specifies the file extensions to use when searching for files in directories.",
       "type": "array"
     },
     "config": {
+      "description": "Specify a different configuration file.",
       "type": "string"
     },
     "global": {
+      "description": "Specify the run context of html-validate.",
       "type": "boolean"
     }
   },