eslint-rules-nodejs v1.0.0

Rules: Node.js

ESLint rules specific to running JavaScript on Node.js.

Installation

$ npm install eslint-rules-nodejs

Usage

var rules = require( 'eslint-rules-nodejs' );

rules

ESLint rules specific to running JavaScript on Node.js.

console.dir( rules );
/*
	{
		'callback-return': [ 1, [
			'callback',
			'clbk',
			'cb',
			'done',
			'next'
		]],
		'handle-callback-err': [ 2, '^(err|error)$' ],
		...
	}
*/

Examples

var merge = require( 'utils-merge2' )(),
	rules = require( 'eslint-rules-nodejs' ),
	RULES = require( './existing_rules.json' );

// Merge the rules for Node.js into an existing ESLint rule set...
RULES = merge( RULES, rules );

console.dir( RULES );

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.