Adding an exclude-files option to the command line interface

Author: jklein

src/cli/common.js

@@ -8,7 +8,7 @@ function cli(api){
     //-------------------------------------------------------------------------
     // Helper functions
     //-------------------------------------------------------------------------
-    
+
     /**
      * Returns an array of messages for a particular type.
      * @param messages {Array} Array of CSS Lint messages.
@@ -18,7 +18,7 @@ function cli(api){
     function pluckByType(messages, type){
         return messages.filter(function(message) {
             return message.type === type;
-        });        
+        });
     }
 
     /**
@@ -29,24 +29,24 @@ function cli(api){
     function gatherRules(options, ruleset){
         var warnings = options.rules || options.warnings,
             errors = options.errors;
-        
+
         if (warnings){
             ruleset = ruleset || {};
             warnings.split(",").forEach(function(value){
                 ruleset[value] = 1;
             });
         }
-        
+
         if (errors){
             ruleset = ruleset || {};
             errors.split(",").forEach(function(value){
                 ruleset[value] = 2;
             });
         }
-           
+
         return ruleset;
     }
-    
+
     /**
      * Filters out rules using the ignore command line option.
      * @param options {Object} the CLI options
@@ -55,17 +55,40 @@ function cli(api){
     function filterRules(options) {
         var ignore = options.ignore,
             ruleset = null;
-        
+
         if (ignore) {
             ruleset = CSSLint.getRuleset();
             ignore.split(",").forEach(function(value){
                 delete ruleset[value];
-            });            
+            });
         }
-        
+
         return ruleset;
     }
 
+
+    /**
+     * Filters out files using the exclude-files command line option.
+     * @param files   {Array}  the list of files to check for exclusions
+     * @param options {Object} the CLI options
+     * @return {Array} A list of files
+     */
+    function filterFiles(files, options) {
+        var excludeFiles = options["exclude-files"],
+            filesToLint = files;
+
+
+        if (excludeFiles) {
+            excludeFiles.split(",").forEach(function(value){
+                if (filesToLint.indexOf(value) > -1) {
+                    filesToLint.splice(filesToLint.indexOf(value),1);
+                }
+            });
+        }
+
+        return filesToLint;
+    }
+
     /**
      * Outputs all available rules to the CLI.
      * @return {void}
@@ -107,12 +130,12 @@ function cli(api){
             if (output){
                 api.print(output);
             }
-            
+
             if (messages.length > 0 && pluckByType(messages, "error").length > 0) {
                 exitCode = 1;
             }
         }
-        
+
         return exitCode;
     }
 
@@ -126,14 +149,15 @@ function cli(api){
             "\nUsage: csslint-rhino.js [options]* [file|dir]*",
             " ",
             "Global Options",
-            "  --help                    Displays this information.",
-            "  --format=<format>         Indicate which format to use for output.",
-            "  --list-rules              Outputs all of the rules available.",
-            "  --quiet                   Only output when errors are present.",
-            "  --errors=<rule[,rule]+>   Indicate which rules to include as errors.",
-            "  --warnings=<rule[,rule]+> Indicate which rules to include as warnings.",
-            "  --ignore=<rule,[,rule]+>  Indicate which rules to ignore completely.",
-            "  --version                 Outputs the current version number."
+            "  --help                          Displays this information.",
+            "  --format=<format>               Indicate which format to use for output.",
+            "  --list-rules                    Outputs all of the rules available.",
+            "  --quiet                         Only output when errors are present.",
+            "  --errors=<rule[,rule]+>         Indicate which rules to include as errors.",
+            "  --warnings=<rule[,rule]+>       Indicate which rules to include as warnings.",
+            "  --ignore=<rule,[,rule]+>        Indicate which rules to ignore completely.",
+            "  --exclude-files=<file,[,file]+> Indicate which files to exclude from being linted.",
+            "  --version                       Outputs the current version number."
         ].join("\n") + "\n");
     }
 
@@ -143,56 +167,58 @@ function cli(api){
      * @param options {Object} options object
      * @return {Number} exit code
      */
-    function processFiles(files, options){
+    function processFiles(fileArray, options){
         var exitCode = 0,
             formatId = options.format || "text",
             formatter,
+            files = filterFiles(fileArray,options),
             output;
-            
+
         if (!files.length) {
             api.print("csslint: No files specified.");
             exitCode = 1;
         } else {
             if (!CSSLint.hasFormat(formatId)){
                 api.print("csslint: Unknown format '" + formatId + "'. Cannot proceed.");
-                exitCode = 1; 
+                exitCode = 1;
             } else {
                 formatter = CSSLint.getFormatter(formatId);
-                
+
                 output = formatter.startFormat();
                 if (output){
                     api.print(output);
                 }
 
+
                 files.forEach(function(file){
                     if (exitCode === 0) {
                         exitCode = processFile(file,options);
                     } else {
                         processFile(file,options);
                     }
                 });
-                
+
                 output = formatter.endFormat();
                 if (output){
                     api.print(output);
                 }
             }
         }
         return exitCode;
-    } 
-    
-    
+    }
+
+
     function processArguments(args, options) {
         var arg = args.shift(),
             argName,
             parts,
             files = [];
-        
+
         while(arg){
             if (arg.indexOf("--") === 0){
                 argName = arg.substring(2);
                 options[argName] = true;
-                
+
                 if (argName.indexOf("=") > -1){
                     parts = argName.split("=");
                     options[parts[0]] = parts[1];
@@ -201,7 +227,7 @@ function cli(api){
                 }
 
             } else {
-                
+
                 //see if it's a directory or a file
                 if (api.isDirectory(arg)){
                     files = files.concat(api.getFiles(arg));
@@ -211,24 +237,24 @@ function cli(api){
             }
             arg = args.shift();
         }
-        
+
         options.files = files;
         return options;
     }
-    
+
     function readConfigFile(options) {
         var data = api.readFile(api.getFullPath(".csslintrc"));
-        if (data) {           
+        if (data) {
             options = processArguments(data.split(/[\s\n\r]+/m), options);
             api.print("ignore = " + options.ignore);
             api.print("errors = " + options.errors);
             api.print("warnings = " + options.warnings);
         }
-    
+
         return options;
     }
-    
-    
+
+
 
     //-----------------------------------------------------------------------------
     // Process command line
@@ -237,10 +263,10 @@ function cli(api){
     var args     = api.args,
         argCount = args.length,
         options  = {};
-        
+
     // first look for config file .csslintrc
-    options = readConfigFile(options);    
-    
+    options = readConfigFile(options);
+
     // Command line arguments override config file
     options = processArguments(args, options);