Add directory skipping option for cli

Author: slyg

bin/jscr.js

@@ -11,17 +11,20 @@ var fs = require('fs'),
 
 
 argvParser.parse(process.argv)
-  .then(argvParser.getTargetedTree)
-  .then(crawlComplexity)
+
+  .then(argvParser.getSpec)
+  .then(function(specs){
+    var path = specs.targetedTree;
+    return crawlComplexity(path, specs);
+  })
   .then(function(data){
 
-    var filename = argvParser.getOutputName(),
+    var filename = argvParser.getOutputFileName(),
         html = generateHTML(data.report)
 
     return writeFile(filename, html);
 
   })
-
   .then(function(){
     process.exit(0);
   })

index.js

@@ -1,4 +1,4 @@
-module.exports = function(srcDir){
+module.exports = function(srcDir, options){
 
     var crawlComplexity = require('./src/crawl-complexity');
 

package.json

@@ -7,7 +7,7 @@
     "type": "git",
     "url": "https://github.com/slyg/jscomplexity.git"
   },
-  "version": "0.0.14",
+  "version": "0.0.15",
   "preferGlobal": "true",
   "bin": {
     "jscr": "./bin/jscr.js"

src/argv-parser.js

@@ -1,33 +1,43 @@
 var program = require('commander'),
     Promise = require('bluebird');
 
-var pjson = require('../package.json');
-
-var targetedTree = './',
-    outputName = 'jscomplexityreport.html',
-    optionsHandler = {};
+var pjson = require('../package.json'),
+    options = {
+      targetedTree : './',
+      getOutputFileName : 'jscr-report.html',
+      skippedDirectories : []
+    };
 
 program
   .version(pjson.version)
-  .usage('[<folder to analyse ...>] [options]');
+  .usage('[options] [<folder to analyse ...>]');
 
 program
   .command('*')
   .action(function(target){
-    targetedTree = target;
+    options.targetedTree = target;
+  });
+
+program
+  .option('-e, --exclude [folder]', 'exclude folders', function(folder){
+    options.skippedDirectories = folder.split(',');
   });
 
 module.exports.parse = function(argv){
   return new Promise(function (resolve) {
     program.parse(argv);
-    resolve(targetedTree);
+    resolve(options.targetedTree);
   });
 };
 
+module.exports.getSpec = function(){
+  return options;
+};
+
 module.exports.getTargetedTree = function(){
-  return targetedTree;
+  return options.targetedTree;
 };
 
-module.exports.getOutputName = function(){
-  return outputName;
+module.exports.getOutputFileName = function(){
+  return options.getOutputFileName;
 };

src/crawl-complexity.js

@@ -123,21 +123,46 @@
 
     }
 
+    /**
+     *
+     */
+
+    function formatOptions(rawOptions){
+
+        var formattedOptions = {
+            followLinks: false
+        };
+
+        if(rawOptions){
+
+            if(
+                rawOptions.skippedDirectories 
+                && rawOptions.skippedDirectories.length > 0
+            ) {
+                formattedOptions.filters = rawOptions.skippedDirectories;
+            }
+
+        }
+
+        return formattedOptions;
+    }
+
     /**
      * builds a complexity report of .js files 
      * found in a file tree from a given path
      *
      *   returns a Promise
      *   rejects promise if any runtime error occurs
      */
-    function buildFinalReport(path){
+    function crawlComplexity(path, options){
 
         var 
             reportList = [],
             errorsList = null,
-            walker = walk.walk(path),
             resolver = Promise.defer()
-        ;  
+        ;
+
+        walker = walk.walk(path, formatOptions(options));
 
         walker
             .on("file", populateReportList(errorsList, reportList))
@@ -154,4 +179,4 @@
 
     }
 
-    module.exports = buildFinalReport;
+    module.exports = crawlComplexity;