Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kgryte/eslint-rules-errors
ESLint rules to catch programmer errors.
https://github.com/kgryte/eslint-rules-errors
Last synced: 25 days ago
JSON representation
ESLint rules to catch programmer errors.
- Host: GitHub
- URL: https://github.com/kgryte/eslint-rules-errors
- Owner: kgryte
- License: mit
- Created: 2015-09-02T18:55:00.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-09-02T20:37:38.000Z (about 9 years ago)
- Last Synced: 2024-10-02T22:37:17.826Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 125 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Rules: Errors
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]
> [ESLint](http://eslint.org/) rules to catch programmer errors.
## Installation
``` bash
$ npm install eslint-rules-errors
```
## Usage
``` javascript
var rules = require( 'eslint-rules-errors' );
```
#### rules
[ESLint](http://eslint.org/) rules to catch programmer errors.
``` javascript
console.dir( rules );
/*
{
'comma-dangle': [ 2, 'never' ],
'no-cond-assign': 2,
...
}
*/
```
## Examples
``` javascript
var merge = require( 'utils-merge2' )(),
rules = require( 'eslint-rules-errors' ),
RULES = require( './existing_rules.json' );
// Merge the rules for programmer errors into an existing ESLint rule set...
RULES = merge( RULES, rules );
console.dir( RULES );
```
To run the example code from the top-level application directory,
``` bash
$ node ./examples/index.js
```
## Tests
### Unit
Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
``` bash
$ make test
```
All new feature development should have corresponding unit tests to validate correct functionality.
### Test Coverage
This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
``` bash
$ make test-cov
```
Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
``` bash
$ make view-cov
```
---
## License
[MIT license](http://opensource.org/licenses/MIT).
## Copyright
Copyright © 2015. Athan Reines.
[npm-image]: http://img.shields.io/npm/v/eslint-rules-errors.svg
[npm-url]: https://npmjs.org/package/eslint-rules-errors
[travis-image]: http://img.shields.io/travis/kgryte/eslint-rules-errors/master.svg
[travis-url]: https://travis-ci.org/kgryte/eslint-rules-errors
[codecov-image]: https://img.shields.io/codecov/c/github/kgryte/eslint-rules-errors/master.svg
[codecov-url]: https://codecov.io/github/kgryte/eslint-rules-errors?branch=master
[dependencies-image]: http://img.shields.io/david/kgryte/eslint-rules-errors.svg
[dependencies-url]: https://david-dm.org/kgryte/eslint-rules-errors
[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/eslint-rules-errors.svg
[dev-dependencies-url]: https://david-dm.org/dev/kgryte/eslint-rules-errors
[github-issues-image]: http://img.shields.io/github/issues/kgryte/eslint-rules-errors.svg
[github-issues-url]: https://github.com/kgryte/eslint-rules-errors/issues