Merge branch 'exposing-extensions-arg'

Author: Nathan-Smith

lib/cli.js

@@ -12,6 +12,7 @@ var cli = commander
   .option('-v, --verbose [verbosity]', 'Set the verbosity level', Number, 1)
   .option('-r, --reporter [reporter]', 'Set the reporter', String, 'spec')
   .option('-filters, --filters [filters]', 'Set a list of ignored errors')
+  .option('-extensions, --extensions [extensions]', 'Set The allowed file extensions that cpplint will check')
   .parse(process.argv);
 
 var options = {};
@@ -38,6 +39,11 @@ if (cli.filters) {
   options.filters = filters.parse(cli.filters);
 }
 
+// set the ignored errors
+if (cli.extensions) {
+  options.extensions = cli.extensions;
+}
+
 // set the remainging options (assume they're files and we should lint them)
 options.files = cli.args;
 

lib/make-args.js

@@ -26,6 +26,20 @@ function counting(type) {
   return '--counting=' + type;
 }
 
+/**
+ * Get the cpplint `extensions` argument
+ *
+ * @param  {String|Array} exts
+ * @return {String}
+ */
+function extensions(exts) {
+  var extsType = {}.toString.call(exts);
+  if (extsType === '[object Array]') {
+    exts = exts.join(',');
+  }
+  return '--extensions=' + exts;
+}
+
 /**
  * Get the cpplint `filter` argument
  *
@@ -109,6 +123,11 @@ function makeArgs(conf, next) {
     args.push(filter(conf.filters));
   }
 
+  if (conf.extensions) {
+    // set filters
+    args.push(extensions(conf.extensions));
+  }
+
   // set files
   args.push(conf.files.join(' '));
 
@@ -123,5 +142,6 @@ module.exports = {
   'makeArgs': makeArgs,
   'filter': filter,
   'counting': counting,
-  'verbosity': verbosity
+  'verbosity': verbosity,
+  'extensions': extensions
 };

lib/parse-output.js

@@ -7,11 +7,11 @@ var expressions = {
   // Done processing /Users/stephenmathieson/work/node-cpplint/test/fixtures/somefile.cc
   'done': {
     'is': /Done processing [\/a-z\-\_\.\d]+/i,
-    'file': / ([\/a-z\-\_\.\d]+)$/i
+    'file': / ([\/a-z\-\_\.\d\+]+)$/i
   },
   // /Users/stephenmathieson/work/node-cpplint/test/fixtures/somefile.cc:302:  Blank line at the end of a code block.  Is this needed?  [whitespace/blank_line] [3]
   'error': {
-    'is': /[\/a-z-_\.]+\:[\d]+\:[ ]{2}.*\[[1-5]\]/i
+    'is': /[\/a-z-_\.\+]+\:[\d]+\:[ ]{2}.*\[[1-5]\]/i
   }
 };
 

readme.md

@@ -21,6 +21,7 @@ a count is provided for each category like `build/class`.
 - **verbose** The verbosity level; defaults to *1*.  A number *0-5* to restrict
 errors to certain verbosity levels.
 - **filters** Enable/disable filtering for specific errors.
+- **extensions** List of file extensions to lint.
 
 
 A list of files is also expected.
@@ -43,9 +44,14 @@ bin/cpplint --verbose 3 --counting detailed file2 file3
 Using the `plain-text` reporter, ignoring *build/deprecated* errors and linting *file1*.
 
 ```bash
-bin/cpplint --filter build-deprecated --reporter plain-text
+bin/cpplint --filter build-deprecated --reporter plain-text file1
 ```
 
+Using the `cc` and `hpp` extensions and linting *source1.cc* and *source1.hpp*.
+
+```bash
+bin/cpplint --extensions cc,hpp source1.cc source1.hpp
+```
 
 ### JavaScript usage
 
@@ -76,7 +82,12 @@ var options = {
       'braces': false,
       'include_alpha': true
     }
-  }
+  },
+  // This could be an array of strings or a comma separated string
+  extensions: [
+    'cc',
+    'hpp'
+  ]
 };
 
 cpplint(options, function (err, report) {
@@ -103,7 +114,12 @@ grunt.initConfig({
       'braces': false,
       'include_alpha': true
     }
-  }
+  },
+  // This could be an array of strings or a comma separated string
+  extensions: [
+    'cc',
+    'hpp'
+  ]
 });
 ```
 

tasks/cpplint.js

@@ -35,6 +35,8 @@ module.exports = function (grunt) {
 
     options.filters = extend(filters.defaults, gruntFilters, true);
 
+    options.extensions = conf('extensions');
+
     options.files = grunt.file.expand(conf('files'));
     options.verbosity = conf('verbosity') || 1;
     options.counting = conf('counting') || 'toplevel';

test/make-args.js

@@ -88,7 +88,12 @@ suite.addBatch({
           'subcat5': false,
           'subcat6': true
         }
-      }
+      },
+      'extensions': [
+        'cpp',
+        'cc',
+        'xx'
+      ]
     }),
     'should set correct verbosity level': function (err, args) {
       assert.includes(args, '--verbose=1');
@@ -101,10 +106,13 @@ suite.addBatch({
     },
     'should pass the correct filters': function (err, args) {
       assert.includes(args, '--filter=+category1/subcat1,-category1/subcat2,+category1/subcat3,+category2/subcat1,-category2/subcat2,+category2/subcat3,+category2/subcat4,-category2/subcat5,+category2/subcat6');
+    },
+    'should pass the correct extensions': function (err, args) {
+      assert.includes(args, '--extensions=cpp,cc,xx');
     }
 
   },
-  'values (without filters)': {
+  'values (without filters or extensions)': {
     topic: makeArgs({
       'verbosity': 1,
       'counting': 'total',
@@ -127,7 +135,16 @@ suite.addBatch({
       assert.includes(args, '/path/to/file1 /path/to/file2');
     },
     'should not pass a filter value': function (err, args) {
-      assert.equal(args.length, 4); // not quite good enough...
+      var i;
+      for (i = 0; i < args.length; i += 1) {
+        assert.isFalse(args[i].indexOf('filter') !== -1, 'filter was in the list of arguments');
+      }
+    },
+    'should not pass an extensions value': function (err, args) {
+      var i;
+      for (i = 0; i < args.length; i += 1) {
+        assert.isFalse(args[i].indexOf('extensions') !== -1, 'extensions was in the list of arguments');
+      }
     }
   }
 });