Newfangled Package Modernizer

    eslint-rules-best-practices

    1.0.0 • Public • Published

    Rules: Best Practices

    NPM version Build Status Coverage Status Dependencies

    ESLint rules for enforcing best practices.

    Installation

    $ npm install eslint-rules-best-practices

    Usage

    var rules = require( 'eslint-rules-best-practices' );

    rules

    ESLint rules for enforcing best practices.

    console.dir( rules );
    /*
        {
            'accessor-pairs': 2,
            'block-scope-var': 2,
            ...
        }
    */

    Examples

    var merge = require( 'utils-merge2' )(),
        rules = require( 'eslint-rules-best-practices' ),
        RULES = require( './existing_rules.json' );
     
    // Merge the rules for best practices 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.

    Install

    npm i eslint-rules-best-practices

    DownloadsWeekly Downloads

    3

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • kgryte