Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

eslint-rules-errors

kgryte6MIT1.0.0

ESLint rules to catch programmer errors.

eslint, eslintconfig, config, javascript, js, style, guide, styleguide, syntax, lint, jshint, jslint, code, policy, quality, standard, rules, errors, errs

readme

Rules: Errors

NPM version Build Status Coverage Status Dependencies

ESLint rules to catch programmer errors.

Installation

$ npm install eslint-rules-errors

Usage

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

rules

ESLint rules to catch programmer errors.

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

Examples

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,

$ 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 © 2015. Athan Reines.