Add directory pattern skipping command-line option

Author: slyg

bin/jscr.js

@@ -14,8 +14,12 @@ argvParser.parse(process.argv)
 
   .then(argvParser.getSpec)
   .then(function(specs){
+
     var path = specs.targetedTree;
-    return crawlComplexity(path, specs);
+    var skipped = specs.skippedDirectory;
+
+    return crawlComplexity(path, skipped);
+    
   })
   .then(function(data){
 

src/argv-parser.js

@@ -19,8 +19,8 @@ program
   });
 
 program
-  .option('-e, --exclude [folder]', 'exclude folders', function(folder){
-    options.skippedDirectories = folder.split(',');
+  .option('-s, --skip <folder>', 'skip a folder', function(folder){
+    options.skippedDirectory = folder;
   });
 
 module.exports.parse = function(argv){

src/crawl-complexity.js

@@ -14,9 +14,10 @@
      *
      *   returns a Promise
      *   rejected promise if not .js
+     *
      *   fulfilled promise returns the passed file reference (path)
      */
-    function checkFileExtension(fileRef){ 
+    function isJavascriptFile(fileRef){ 
 
         var resolver = Promise.defer();
 
@@ -29,6 +30,40 @@
         return resolver.promise;
     }
 
+
+
+    /**
+     * Checks for file not to be skipped
+     *
+     *   returns a Promise
+     *   rejected promise if 'fileRef' matches 'skipped' String value
+     *   fulfilled promise if 'skipped' is falsy or empty
+     *
+     *   fulfilled promise returns the passed file reference (path)
+     */
+
+    function isNotSkipped(fileRef, skipped){
+
+        var 
+            skippedRegExp = new RegExp(skipped, 'g')
+        ;
+
+        if(typeof skipped === 'string') {
+            
+            if( fileRef.match(skippedRegExp) ) {
+                throw new Error(fileRef + ' is skipped');
+            } else {
+                return fileRef;
+            }
+
+        } else {
+
+            return fileRef;
+
+        }
+
+    }
+
     /**
      * Reads JS file
      *
@@ -90,7 +125,7 @@
      *
      *   returns a Function
      */
-    function populateReportList(errorsList, reportList){
+    function populateReportList(errorsList, reportList, skipped){
 
         /**
          * Populates error and report stack objects 
@@ -103,7 +138,11 @@
 
             var fileRef = require('path').normalize(root + "/" + fileStats.name);
 
-            checkFileExtension(fileRef)
+            Promise.resolve(fileRef)
+                .then(isJavascriptFile, next)
+                .then(function(fileRef){
+                    return isNotSkipped(fileRef, skipped);
+                })
                 .caught(next) // fire 'next' if extension is not correct
                 .then(readJSFile)
                 .then(buildFileReport)
@@ -123,49 +162,25 @@
 
     }
 
-    /**
-     *
-     */
-
-    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 crawlComplexity(path){
+    function crawlComplexity(path, skippedFolder){
 
         var 
             reportList = [],
             errorsList = null,
             resolver = Promise.defer()
         ;
 
-        var walker = walk.walk(path);
+        var walker = walk.walk(path || './');
 
         walker
-            .on("file", populateReportList(errorsList, reportList))
+            .on("file", populateReportList(errorsList, reportList, skippedFolder))
             .on("error", function(){ resolver.reject('runtime error'); })
             .on("end", function(){
                 resolver.resolve({

test/index.js

@@ -12,6 +12,7 @@ var chai = require('chai'),
   treePathNotExisting = '/doesntexist',
   crawler = require('../src/crawl-complexity'),
   expectedComplexRes = require('./complex-tree-results'),
+  expectedSkipRes = require('./skip-results'),
   expectedEmptyRes = { report : [], errors : null };
 
 chai.use(chaiAsPromised);
@@ -54,4 +55,14 @@ describe('the complexity crawler promise', function () {
 
   });
 
+  it('should return the attended complex result when a skip folder path is passed', function(done){
+
+    this.timeout(10000);
+
+    expect(crawler(treePathComplex, '/tree/complex/jquery'))
+      .to.eventually.deep.equal(expectedSkipRes)
+      .to.be.fulfilled.and.notify(done);
+    
+  });
+
 });

test/skip-results.json

@@ -0,0 +1,12 @@
+{ 
+  "report":
+   [ { "path": "test/tree/complex/empty.js",
+       "escapedPath": "test/tree/complex/empty.js",
+       "complexity": 1,
+       "lineNumber": 0,
+       "maintainability": 0,
+       "halstead": { "length": 0, "vocabulary": 0, "difficulty": 0, "bugs": 0 } 
+    }
+    ],
+  "errors": null 
+}