@earnest/eslint-config

Earnest's ESLint config, following our style guide

Stats

StarsIssuesVersionUpdatedCreatedSize
@earnest/eslint-config
123.4.04 months ago6 years agoMinified + gzip package size for @earnest/eslint-config in KB

Readme

eslint-config-earnest

Shareable ESLint configuration for the Earnest JavaScript style guide.

If you are looking for an ES7 version, look here.

Usage

  1. Install the following "devDependencies" in your repo:

    npm i --save-dev @earnest/eslint-config@latest

  2. Add a root level .eslintrc that references this package

    echo '{ "extends": "@earnest/eslint-config" }' > .eslintrc
    
  3. Add another .eslintrc to your test folder that supports mocha

    npm install eslint-plugin-mocha --save-dev
    echo '{ "extends": "@earnest/eslint-config/mocha" }' > test/.eslintrc
    
  4. (Recommended) Add the following entries to your package.json for simplified CLI access to linting:

    "scripts": {
      "lint": "./node_modules/.bin/eslint .",
      "lint-changed": "git diff --name-only --cached --relative | grep '\\.js$' | xargs ./node_modules/.bin/eslint"
    }
    
  5. (Recommended) Setup your editor to support inline ESLint support. For Sublime Text, that means npm install -g eslint then installing SublimeLinter and SublimeLinter-contrib-eslint packages. For Vim, use Syntastic.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.