Rename runner to validator

jhinch · Dec 30, 2018 · 5eca1d4 · 5eca1d4
1 parent fe29987
commit 5eca1d4
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 15 deletions.
diff --git a/bin/_cli/commands.js b/bin/_cli/commands.js
@@ -1,6 +1,7 @@
 let fs = require('fs');
 let parser = require('../../lib/parser');
-let runRules = require('../../lib/rules').run;
+let {runRules} = require('../../lib/validator');
+let builtinRules = require('../../lib/rules').builtins;
 let optionsParser = require('./options');
 let {table, getBorderCharacters} = require('table');
 let chalk = require('chalk');
@@ -63,7 +64,8 @@ function help(options, output) {
     output.log('--help                 Print this help message and exit');
     output.log(`--config <file>        Specify the configuration file to use. Default (${optionsParser.defaults.config})`);
     output.log(`--include <file|glob>  Include the file or glob in nginx files to validate. Can be specified multiple times. Default (${optionsParser.defaults.includes.join(', ')})`);
-    output.log('--exclude <file|glob>  Exclue a file or glob in the nginx files to validate. Can be specieid multiple times. Excludes take precedence over includes');
+    output.log('--exclude <file|glob>  Exclude a file or glob in the nginx files to validate. Can be specieid multiple times. Excludes take precedence over includes');
+    output.log('--no-follow-includes   Disable the default behaviour of following include directives found in the nginx configuration');
     return error ? 1 : 0;
 }
 
@@ -72,7 +74,7 @@ function validate(options, output) {
     let errorCount = files.map(file => {
         let fileContents = fs.readFileSync(file, 'utf8');
         let parseTree = parser.parse(fileContents);
-        let results = runRules(parseTree);
+        let results = runValidationWithBuiltins(parseTree);
         if (results.length) {
             outputResults(file, results, output);
         }
@@ -82,6 +84,10 @@ function validate(options, output) {
     return errorCount ? 1 : 0;
 }
 
+function runValidationWithBuiltins(parseTree) {
+    return runRules(parseTree, builtinRules);
+}
+
 function findFiles(includes, excludes) {
     let includedFiles = findMatchingFiles(includes);
     let excludedFiles = findMatchingFiles(excludes);

diff --git a/bin/_cli/options.js b/bin/_cli/options.js
@@ -42,6 +42,9 @@ function parse(args) {
                     customizedExcludes = true;
                 }
                 break;
+            case '--no-follow-includes':
+                options.followIncludes = false;
+                break;
             case '--help':
                 options.command = 'help';
                 break;

diff --git a/lib/rules/index.js b/lib/rules/index.js
@@ -1,5 +1,3 @@
-let {runRules} = require('./runner');
-
 let builtins = [
     require('./rule-if-is-evil'),
     require('./rule-indentation'),
@@ -8,11 +6,6 @@ let builtins = [
     require('./rule-trailing-whitespace'),
 ];
 
-function run(root, options) {
-    return runRules(root, builtins, options);
-}
-
 module.exports = {
     builtins,
-    run,
 };
diff --git a/lib/rules/runner.js → lib/validator.js b/lib/rules/runner.js → lib/validator.js
diff --git a/test/rules/rule-if-is-evil.spec.js b/test/rules/rule-if-is-evil.spec.js
@@ -2,7 +2,7 @@ let assert = require('assert');
 let fs = require('fs');
 let path = require('path');
 let parser = require('../../lib/parser');
-let {runRules} = require('../../lib/rules/runner');
+let {runRules} = require('../../lib/validator');
 let ifIsEvilRule = require('../../lib/rules/rule-if-is-evil');
 
 function testConfig(name, mode, contents, expectedErrors) {

diff --git a/test/rules/rule-indentation.spec.js b/test/rules/rule-indentation.spec.js
@@ -2,7 +2,7 @@ let assert = require('assert');
 let fs = require('fs');
 let path = require('path');
 let parser = require('../../lib/parser');
-let {runRules} = require('../../lib/rules/runner');
+let {runRules} = require('../../lib/validator');
 let indentationRule = require('../../lib/rules/rule-indentation');
 
 function testConfig(name, setting, contents, expectedErrors) {

diff --git a/test/rules/rule-line-ending.spec.js b/test/rules/rule-line-ending.spec.js
@@ -2,7 +2,7 @@ let assert = require('assert');
 let fs = require('fs');
 let path = require('path');
 let parser = require('../../lib/parser');
-let {runRules} = require('../../lib/rules/runner');
+let {runRules} = require('../../lib/validator');
 let lineEndingRule = require('../../lib/rules/rule-line-ending');
 
 function testConfig(name, lineEnding, contents, expectedErrors) {

diff --git a/test/rules/rule-strict-location.spec.js b/test/rules/rule-strict-location.spec.js
@@ -2,7 +2,7 @@ let assert = require('assert');
 let fs = require('fs');
 let path = require('path');
 let parser = require('../../lib/parser');
-let {runRules} = require('../../lib/rules/runner');
+let {runRules} = require('../../lib/validator');
 let strictLocationRule = require('../../lib/rules/rule-strict-location');
 
 function testConfig(name, contents, expectedErrors) {

diff --git a/test/rules/rule-trailing-whitespace.spec.js b/test/rules/rule-trailing-whitespace.spec.js
@@ -2,7 +2,7 @@ let assert = require('assert');
 let fs = require('fs');
 let path = require('path');
 let parser = require('../../lib/parser');
-let {runRules} = require('../../lib/rules/runner');
+let {runRules} = require('../../lib/validator');
 let trailingWhitespaceRule = require('../../lib/rules/rule-trailing-whitespace');
 
 function testConfig(name, contents, expectedErrors) {