node-cpplint

node-cpplint

Validates CPP files with Google's cpplint

Usage

This module has been built for both usage with Node scripts and from the command line.

CLI usage

The CLI accepts the following parameters:

• reporter The reporter to use (spec|json|plain-text); defaults to spec.
• counting The counting-type (total|toplevel|detailed; defaults to total. The total number of errors found is always printed. If 'toplevel' is provided, then the count of errors in each of the top-level categories like 'build' and 'whitespace' will also be printed. If 'detailed' is provided, then 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.

Example

bin/cpplint --verbose (1-5) --reporter (spec|json|plain-text) --counting (total|toplevel|detailed) file1 file2 ...

JavaScript usage

Using the spec reporter

var cpplint = require('lib/index.js');
var reporter = require('lib/reporters').spec;
var options = {
	files: [
		'/path/to/some/files.cc'
	]
};

cpplint(options, reporter);

Using a custom reporter

var cpplint = require('lib/index');
var options = {
	files: [
		'/path/to/some/files.cc'
	]
};

cpplint(options, function (err, report) {
	// your reporting logic
});

TODO

Future plans (in no perticular order):

• grunt task
• support for filters
• JUnit-xml reporter

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests (using vows) for any new or changed functionality. Lint and test your code using grunt jslint and verify that all unit tests are passing with grunt vows.

Revision History

0.1.0

• first public version
• provides a few simple options for validating CPP files