eslint-rules-default v1.0.0

Default Rules

A set of default rules for ESLint.

Installation

$ npm install eslint-rules-default

Usage

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

rules

A set of default rules for ESLint.

console.dir( rules );
/*
	{
		'comma-dangle': [ 2, 'never' ],
		'no-cond-assign': 2,
		'no-console': 1,
		'no-constant-condition': 2,
		'no-control-regex': 2,
		...
	}
*/

Examples

var merge = require( 'utils-merge2' )(),
	rules = require( 'eslint-rules-default' ),
	config = require( './existing_config.json' );

// Add the rules to an existing ESLint config...
config.rules = rules;
console.dir( config );

// Override certain rules...
rules = merge( rules, {
	'eol-last': 1,
	'func-names': 1,
	'no-nested-ternary': 1,
	'semi': [ 2, 'never' ]
});
console.dir( config );

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.