feat(spectral): allow spectral ruleset file to be specified with command line option

Author: Mike Kistler

README.md

@@ -86,6 +86,7 @@ Once pulled, the container can be run directly, but mount a volume containing th
 -  -v (--version) : Print the current semantic version of the validator
 -  -h (--help) : This option prints the usage menu.
 -  -c (--config) <path/to/your/config> : Path to a validator configuration file.  If provided, this is used instead of .validaterc.
+-  -r (--ruleset) <path/to/your/ruleset> : Path to Spectral ruleset file, used instead of .spectral.yaml if provided.
 -  --debug : Enable debugging output.
 
 _These options only apply to running the validator on a file, not to any commands._

src/cli-validator/index.js

@@ -40,6 +40,9 @@ program
   .option(
     '-c, --config <file>', 'path to config file, used instead of .validaterc if provided'
   )
+  .option(
+    '-r, --ruleset <file>', 'path to Spectral ruleset file, used instead of .spectral.yaml if provided'
+  )
   .option(
     '-e, --errors_only',
     'only print the errors, ignore the warnings'

src/cli-validator/runValidator.js

@@ -42,6 +42,7 @@ const processInput = async function(program) {
   const debug = !!program.debug;
 
   const configFileOverride = program.config;
+  const rulesetFileOverride = program.ruleset;
 
   const limitsFileOverride = program.limits;
 
@@ -166,7 +167,7 @@ const processInput = async function(program) {
   // or the default ruleset
   const spectral = new Spectral();
   try {
-    await spectralValidator.setup(spectral, configObject);
+    await spectralValidator.setup(spectral, rulesetFileOverride, configObject);
   } catch (err) {
     return Promise.reject(err);
   }

src/cli-validator/utils/processConfiguration.js

@@ -373,13 +373,16 @@ const validateConfigOption = function(userOption, defaultOption) {
   return result;
 };
 
-const getSpectralRuleset = async function(defaultRuleset) {
+const getSpectralRuleset = async function(rulesetFileOverride, defaultRuleset) {
   // List of ruleset files to search for
   const ruleSetFilesToFind = [
     '.spectral.yaml',
     '.spectral.yml',
     '.spectral.json'
   ];
+  if (rulesetFileOverride) {
+    ruleSetFilesToFind.splice(0, 0, rulesetFileOverride);
+  }
   let ruleSetFile;
 
   // search up the file system for the first ruleset file found

src/lib/index.js

@@ -16,7 +16,7 @@ module.exports = async function(input, defaultMode = false) {
 
   try {
     configObject = await config.get(defaultMode, chalk);
-    await spectralValidator.setup(spectral, configObject);
+    await spectralValidator.setup(spectral, null, configObject);
   } catch (err) {
     return Promise.reject(err);
   }

src/spectral/utils/spectral-validator.js

@@ -54,7 +54,7 @@ const parseResults = function(results, debug) {
 };
 
 // setup: registers the oas2/oas3 formats, and attempts to load the ruleset file
-const setup = async function(spectral, configObject) {
+const setup = async function(spectral, rulesetFileOverride, configObject) {
   if (!spectral) {
     const message =
       'Error (spectral-validator): An instance of spectral has not been initialized.';
@@ -73,6 +73,7 @@ const setup = async function(spectral, configObject) {
 
   // load the spectral ruleset, either a user's or the default ruleset
   const spectralRulesetURI = await config.getSpectralRuleset(
+    rulesetFileOverride,
     defaultSpectralRulesetURI
   );