Merge pull request #11 from arkadiyt/at-line-length

Add support for --linelength option

Author: stephenmathieson

lib/cli.js

@@ -13,6 +13,7 @@ var cli = commander
   .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')
+  .option('-l, --linelength [linelength]', 'Set the allowed line length', Number)
   .parse(process.argv);
 
 var options = {};
@@ -39,11 +40,16 @@ if (cli.filters) {
   options.filters = filters.parse(cli.filters);
 }
 
-// set the ignored errors
+// set the extensions
 if (cli.extensions) {
   options.extensions = cli.extensions;
 }
 
+// set the linelength
+if (cli.linelength) {
+  options.linelength = cli.linelength;
+}
+
 // set the remainging options (assume they're files and we should lint them)
 options.files = cli.args;
 

lib/make-args.js

@@ -40,6 +40,16 @@ function extensions(exts) {
   return '--extensions=' + exts;
 }
 
+/**
+ * Get the cpplint `linelength` argument
+ *
+ * @param {Number} length
+ * @return {String}
+ */
+function linelength(length) {
+  return '--linelength=' + length;
+}
+
 /**
  * Get the cpplint `filter` argument
  *
@@ -128,6 +138,11 @@ function makeArgs(conf, next) {
     args.push(extensions(conf.extensions));
   }
 
+  //set linelength
+  if (conf.linelength) {
+    args.push(linelength(conf.linelength));
+  }
+
   // set files
   args.push(conf.files.join(' '));
 
@@ -140,6 +155,7 @@ function makeArgs(conf, next) {
 
 module.exports = {
   'makeArgs': makeArgs,
+  'linelength': linelength,
   'filter': filter,
   'counting': counting,
   'verbosity': verbosity,

readme.md

@@ -9,7 +9,7 @@ line, and to be used as a Grunt task.
 
 ### Options
 
-All methods of using this module allow for four specific configuration options:
+All methods of using this module allow for these specific configuration options:
 
 - **reporter** The reporter to use ( *spec* | *json* | *plain-text* ); defaults
 to *spec*.
@@ -22,11 +22,10 @@ a count is provided for each category like `build/class`.
 errors to certain verbosity levels.
 - **filters** Enable/disable filtering for specific errors.
 - **extensions** List of file extensions to lint.
-
+- **linelength** The allowed line length.
 
 A list of files is also expected.
 
-
 ### CLI usage
 
 Using the `spec` reporter, disabling *whitespace/braces* errors and linting *file1*.
@@ -35,10 +34,10 @@ Using the `spec` reporter, disabling *whitespace/braces* errors and linting *fil
 bin/cpplint --reporter spec --filter whitespace-braces file1
 ```
 
-Setting verbosity to `3` and the counting-type to `detailed` while linting *file1* and *file2*.
+Setting verbosity to `3`, line length to `120`, and the counting-type to `detailed` while linting *file1* and *file2*.
 
 ```bash
-bin/cpplint --verbose 3 --counting detailed file2 file3
+bin/cpplint --verbose 3 --counting detailed --linelength 120 file2 file3
 ```
 
 Using the `plain-text` reporter, ignoring *build/deprecated* errors and linting *file1*.
@@ -115,6 +114,7 @@ grunt.initConfig({
       'include_alpha': true
     }
   },
+  linelength: 120,
   // This could be an array of strings or a comma separated string
   extensions: [
     'cc',
@@ -129,7 +129,6 @@ Future plans (in no particular order):
 - better test coverage
 - xunit-xml reporter
 
-
 ## Contributing
 
 In lieu of a formal styleguide, take care to maintain the existing coding
@@ -168,7 +167,6 @@ and verify that all unit tests are passing with `grunt vows`.
 ### 0.1.1
 - added simple grunt task
 
-
 ### 0.1.0
 
 - first public version

tasks/cpplint.js

@@ -40,6 +40,7 @@ module.exports = function (grunt) {
     options.files = grunt.file.expand(conf('files'));
     options.verbosity = conf('verbosity') || 1;
     options.counting = conf('counting') || 'toplevel';
+    options.linelength = conf('linelength');
 
     cpplint(options, function (err, report) {
 

test/make-args.js

@@ -92,7 +92,8 @@ suite.addBatch({
         'cpp',
         'cc',
         'xx'
-      ]
+      ],
+      'linelength': 120
     }),
     'should set correct verbosity level': function (err, args) {
       assert.includes(args, '--verbose=1');
@@ -108,6 +109,9 @@ suite.addBatch({
     },
     'should pass the correct extensions': function (err, args) {
       assert.includes(args, '--extensions=cpp,cc,xx');
+    },
+    'should pass the correct linelength': function (err, args) {
+      assert.includes(args, '--linelength=120');
     }
 
   },