Skip to content

Earnest-Labs/eslint-config-earnest-es7

Repository files navigation

eslint-config-earnest-es7

Earnest's ESLint config for ES7

Usage

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

    npm install @earnest/eslint-config-es7@latest babel-core babel-cli babel-eslint babel-preset-es2015 babel-preset-stage-3 eslint eslint-plugin-babel --save-dev
    
  2. Add a root level .eslintrc that references this package

    echo '{"extends": "@earnest/eslint-config-es7"}' > .eslintrc
    

    Alternatively add this entry to your package.json:

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

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

    "scripts": {
      "lint": "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 --global eslint then installing SublimeLinter and SublimeLinter-contrib-eslint packages. For Vim, use ALE or Syntastic. (ALE is asynchronous and requires Vim 8.)

Linting this Repository

In order to run linting against this repository, you must create a self-referential link to this module:

npm install
npm link
npm link @earnest/eslint-config-es7
npm run lint

About

Earnest's ESLint config for ES7, following StandardJS with added checks

Resources

License

Stars

Watchers

Forks

Packages

No packages published