0.1.2: filters support

Author: Stephen Mathieson

lib/cli.js

@@ -4,11 +4,14 @@ var commander = require('commander');
 
 var cpplint = require('./index.js');
 
+var filters = require('./filters.js');
+
 var reporters = require('./reporters/index.js');
 
 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')
 	.parse(process.argv);
 
 var options = {};
@@ -30,7 +33,13 @@ if (!options.reporter) {
 // set the verbosity level
 options.verbosity = cli.verbose;
 
-// set the remainging options (assume we should lint them)
+// set the ignored errors
+if (cli.filters) {
+	options.filters = filters.parse(cli.filters);
+}
+
+// set the remainging options (assume they're files and we should lint them)
 options.files = cli.args;
 
+// run this thingy
 cpplint(options, options.reporter);

lib/make-args.js

@@ -72,6 +72,29 @@ function filter(filters) {
 
 	return '--filter=' + result;
 }
+/*
+function filter(excluded) {
+	'use strict';
+
+	var index, length, exclude,
+		parts, category, subcategory,
+		result = '';
+
+	for (index = 0, length = excluded.length; index < length; index += 1) {
+
+		exclude = excluded[index];
+
+		parts = exclude.split('-');
+		category = parts[0];
+		subcategory = parts[1];
+
+		result += '-' + category + '/' + subcategory;
+
+	}
+
+	return '--filter=';
+}
+*/
 
 /**
  * Get arguments for cpplint

lib/parse-options.js

@@ -23,19 +23,17 @@ var MIN_VERBOSITY = 0;
 var defaults = {};
 defaults.verbosity = 1;
 defaults.counting = 'total';
-
+defaults.filters = require('./filters.js').defaults;
 
 /**
- * [parseOptions description]
- *
  * @async
  * @param  {Object} options
  * @param  {Function} next
  */
 function parseOptions(options, next) {
 	'use strict';
 
-	var conf = extend(defaults, options);
+	var conf = extend(defaults, options, true);
 
 	if (!conf.files || !conf.files.length) {
 		return next(new Error('must provide some files'));

package.json

@@ -3,7 +3,7 @@
 
 	"description": "Validates C++ files with cpplint",
 
-	"version": "0.1.1",
+	"version": "0.1.2",
 
 	"homepage": "https://github.com/stephenmathieson/node-cpplint",
 

readme.md

@@ -9,7 +9,7 @@ line, and to be used as a Grunt task.
 
 ### Options
 
-All methods of using this module allow for three specific configuration options:
+All methods of using this module allow for four specific configuration options:
 
 - **reporter** The reporter to use ( *spec* | *json* | *plain-text* ); defaults
 to *spec*.
@@ -20,16 +20,33 @@ is provided, then the count of errors in each of the top-level categories like
 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.
+
 
 A list of files is also expected.
 
 
 ### CLI usage
 
+Using the `spec` reporter, disabling *whitespace/braces* errors and linting *file1*.
+
+```bash
+bin/cpplint --reporter spec --filter whitespace-braces file1
+```
+
+Setting verbosity to `3` and the counting-type to `detailed` while linting *file1* and *file2*.
+
 ```bash
-bin/cpplint --verbose (1-5) --reporter (spec|json|plain-text) --counting (total|toplevel|detailed) file1 file2 ...
+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
+```
+
+
 ### JavaScript usage
 
 Using the `spec` reporter
@@ -46,14 +63,20 @@ var options = {
 cpplint(options, reporter);
 ```
 
-Using a custom reporter
+Using a custom reporter, disabling *whitespace/braces* and enabling *whitespace/include_alpha*
 
 ```javascript
 var cpplint = require('lib/index');
 var options = {
 	files: [
 		'/path/to/some/files.cc'
-	]
+	],
+	filters: {
+		'whitespace': {
+			'braces': false,
+			'include_alpha': true
+		}
+	}
 };
 
 cpplint(options, function (err, report) {
@@ -64,6 +87,8 @@ cpplint(options, function (err, report) {
 ### Grunt Task
 
 ```javascript
+grunt.loadNpmTasks('node-cpplint');
+
 grunt.initConfig({
 	cpplint: {
 		files: [
@@ -72,6 +97,12 @@ grunt.initConfig({
 		],
 		reporter: 'spec',
 		verbosity: 1
+	},
+	filters: {
+		'whitespace': {
+			'braces': false,
+			'include_alpha': true
+		}
 	}
 });
 ```
@@ -80,8 +111,7 @@ grunt.initConfig({
 
 Future plans (in no perticular order):
 - better test coverage
-- support for `filters`
-- JUnit-xml reporter
+- xunit-xml reporter
 
 
 ## Contributing
@@ -93,6 +123,9 @@ and verify that all unit tests are passing with `grunt vows`.
 
 ## Revision History
 
+### 0.1.2
+- added support for ignoring certain errors (filters)
+
 ### 0.1.1
 - added simple grunt task
 

test/runner.js

@@ -178,4 +178,4 @@ suite.addBatch({
 });
 
 
-suite.export(module);
+suite.export(module);