1.0.3 • Published 9 years ago
eslint-rules-style v1.0.3
Rules: Style
ESLint rules which enforce style.
Installation
$ npm install eslint-rules-style
Usage
var rules = require( 'eslint-rules-style' );
rules
ESLint rules which enforce style.
console.dir( rules );
/*
{
'array-bracket-spacing': [ 2, 'always', {
'singleValue': true,
'objectsInArrays': false,
'arraysInArrays': false
}],
'block-spacing': [ 2, 'always' ]
...
}
*/
Examples
var merge = require( 'utils-merge2' )(),
rules = require( 'eslint-rules-style' ),
RULES = require( './existing_rules.json' );
// Merge the rules for style 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
Copyright
Copyright © 2015. Athan Reines.