Add support for "info" and "hint" severity levels (#219)

* feat: add support for info and hint messages

* test: batch tests to improve test performance

Author: Mike Kistler

README.md

@@ -155,7 +155,8 @@ The object will always have `errors` and `warnings` keys that map to arrays. If
 
 ## Configuration
 The command line validator is built so that each IBM validation can be configured. To get started configuring the validator, [set up](#setup) a [configuration file](#configuration-file) and continue reading this section.
-Specific validation "rules" can be turned off, or configured to trigger either errors or warnings in the validator. Some validations can be configured even further, such as switching the case convention to validate against for parameter names.
+Specific validation "rules" can be turned off, or configured to trigger an error, warning, info, or hint message in the validator output.
+Some validations can be configured even further, such as switching the case convention to validate against for parameter names.
 Additionally, certain files can be ignored by the validator. Any glob placed in a file called `.validateignore` will always be ignored by the validator at runtime. This is set up like a `.gitignore` or a `.eslintignore` file.
 
 ### Setup
@@ -298,7 +299,7 @@ The supported rules are described below:
 
 #### Statuses
 
-Each rule can be assigned a status. The supported statuses are `error`, `warning`, and `off`.
+Each rule can be assigned a status. The supported statuses are `error`, `warning`, `info`, `hint` and `off`.
 Some rules can be configured further with configuration options. The format of this configuration is to provide an array, rather than just a string. e.g.
 `"param_name_case_convention": ["error", "lower_camel_case"]`
 If just a string is provided for these rule, the default configuration option will be used. If only one value is provided in the array, it **MUST** be a status. The default configuration option will be used in this case as well. The rules that support configuration options will have **two** values in the [defaults](#default-values) table.

src/cli-validator/runValidator.js

@@ -277,12 +277,14 @@ const processInput = async function(program) {
     // if errorsOnly is true, only errors will be returned, so need to force this to false
     if (errorsOnly) {
       results.warning = false;
+      results.info = false;
+      results.hint = false;
     }
 
     if (jsonOutput) {
       printJson(results, originalFile, errorsOnly);
     } else {
-      if (results.error || results.warning) {
+      if (results.error || results.warning || results.info || results.hint) {
         print(
           results,
           chalk,

src/cli-validator/utils/printResults.js

@@ -14,10 +14,14 @@ module.exports = function print(
   originalFile,
   errorsOnly
 ) {
-  const types = errorsOnly ? ['errors'] : ['errors', 'warnings'];
+  const types = errorsOnly
+    ? ['errors']
+    : ['errors', 'warnings', 'infos', 'hints'];
   const colors = {
     errors: 'bgRed',
-    warnings: 'bgYellow'
+    warnings: 'bgYellow',
+    infos: 'bgGrey',
+    hints: 'bgGreen'
   };
 
   // define an object template in the case that statistics reporting is turned on
@@ -27,6 +31,12 @@ module.exports = function print(
     },
     warnings: {
       total: 0
+    },
+    infos: {
+      total: 0
+    },
+    hints: {
+      total: 0
     }
   };
 
@@ -91,8 +101,19 @@ module.exports = function print(
       chalk.cyan(`  Total number of errors   : ${stats.errors.total}`)
     );
     console.log(
-      chalk.cyan(`  Total number of warnings : ${stats.warnings.total}\n`)
+      chalk.cyan(`  Total number of warnings : ${stats.warnings.total}`)
     );
+    if (stats.infos.total > 0) {
+      console.log(
+        chalk.cyan(`  Total number of infos    : ${stats.infos.total}`)
+      );
+    }
+    if (stats.hints.total > 0) {
+      console.log(
+        chalk.cyan(`  Total number of hints    : ${stats.hints.total}`)
+      );
+    }
+    console.log('');
 
     types.forEach(type => {
       // print the type, either error or warning

src/cli-validator/utils/processConfiguration.js

@@ -100,8 +100,8 @@ const validateConfigObject = function(configObject, chalk) {
           return; // skip statuses for invalid rule
         }
 
-        // check that all statuses are valid (either 'error', 'warning', or 'off')
-        const allowedStatusValues = ['error', 'warning', 'off'];
+        // check that all statuses are valid (either 'error', 'warning', 'info', 'hint' or 'off')
+        const allowedStatusValues = ['error', 'warning', 'info', 'hint', 'off'];
         let userStatus = configObject[spec][category][rule];
 
         // if the rule supports an array in configuration,

src/cli-validator/utils/validator.js

@@ -43,8 +43,12 @@ module.exports = function validateSwagger(
   const validationResults = {
     errors: {},
     warnings: {},
+    infos: {},
+    hints: {},
     error: false,
-    warning: false
+    warning: false,
+    info: false,
+    hint: false
   };
 
   // use version specific and shared validations
@@ -66,6 +70,14 @@ module.exports = function validateSwagger(
     validationResults.warnings[key] = [...parsedSpectralResults.warnings];
     validationResults.warning = true;
   }
+  if (parsedSpectralResults.infos.length) {
+    validationResults.infos[key] = [...parsedSpectralResults.infos];
+    validationResults.info = true;
+  }
+  if (parsedSpectralResults.hints.length) {
+    validationResults.hints[key] = [...parsedSpectralResults.hints];
+    validationResults.hint = true;
+  }
 
   // run circular reference validator
   if (allSpecs.circular) {
@@ -93,6 +105,14 @@ module.exports = function validateSwagger(
       validationResults.warnings[key] = [...problem.warnings];
       validationResults.warning = true;
     }
+    if (problem.infos.length) {
+      validationResults.infos[key] = [...problem.infos];
+      validationResults.info = true;
+    }
+    if (problem.hints.length) {
+      validationResults.hints[key] = [...problem.hints];
+      validationResults.hint = true;
+    }
   });
 
   Object.keys(sharedSemanticValidators).forEach(key => {
@@ -111,6 +131,20 @@ module.exports = function validateSwagger(
       );
       validationResults.warning = true;
     }
+    if (problem.infos.length) {
+      validationResults.infos[key] = [].concat(
+        validationResults.infos[key] || [],
+        problem.infos
+      );
+      validationResults.info = true;
+    }
+    if (problem.hints.length) {
+      validationResults.hints[key] = [].concat(
+        validationResults.hints[key] || [],
+        problem.hints
+      );
+      validationResults.hint = true;
+    }
   });
 
   // run structural validator

src/plugins/utils/messageCarrier.js

@@ -4,7 +4,9 @@ module.exports = class MessageCarrier {
   constructor() {
     this._messages = {
       error: [],
-      warning: []
+      warning: [],
+      info: [],
+      hint: []
     };
   }
 
@@ -20,7 +22,15 @@ module.exports = class MessageCarrier {
     return this._messages.warning;
   }
 
-  // status should be 'off', 'error', or 'warning'
+  get infos() {
+    return this._messages.info;
+  }
+
+  get hints() {
+    return this._messages.hint;
+  }
+
+  // status should be 'off', 'error', 'warning', 'info', or 'hint'
   addMessage(path, message, status) {
     if (this._messages[status]) {
       this._messages[status].push({

src/spectral/utils/spectral-validator.js

@@ -17,20 +17,25 @@ const parseResults = function(results, debug) {
         const message = validationResult['message'];
         const path = validationResult['path'];
 
+        if (code === 'parser') {
+          // Spectral doesn't allow disabling parser rules, so don't include them
+          // in the output (for now)
+          continue;
+        }
+
         if (typeof severity === 'number' && code && message && path) {
-          if (code === 'parser') {
-            // Spectral doesn't allow disabling parser rules, so don't include them
-            // in the output (for now)
-            continue;
-          }
-          // Our validator only supports warning/error level, so only include
-          // those validation results (for now)
-          if (severity === 1) {
-            // warning
-            messages.addMessage(path, message, 'warning');
-          } else if (severity === 0) {
+          if (severity === 0) {
             // error
             messages.addMessage(path, message, 'error');
+          } else if (severity === 1) {
+            // warning
+            messages.addMessage(path, message, 'warning');
+          } else if (severity === 2) {
+            // info
+            messages.addMessage(path, message, 'info');
+          } else if (severity === 3) {
+            // hint
+            messages.addMessage(path, message, 'hint');
           }
         } else {
           if (debug) {