eslint-config-neofonie

eslint-config-neofonie

This package provides neofonie's .eslintrc as a shared npm module. This is similar to that of airbnb's extensible shared config.

Usage

There are two ESLint configurations available.

eslint-config-neofonie

The default export contains all of our ESLint rules, including EcmaScript 6+.

1. npm install --save-dev eslint-config-neofonie eslint
2. add "extends": "neofonie" to your .eslintrc

eslint-config-neofonie/legacy

Lints ES5 and below.

1. npm install --save-dev eslint-config-neofonie eslint
2. add "extends": "neofonie/legacy" to your .eslintrc

eslint-config-neofonie/legendary

Lints according to our current rules at Neofonie

1. npm install --save-dev eslint-config-neofonie eslint
2. add "extends": "neofonie/legendary" to your .eslintrc

IDE Integration

Install the ESLint validator plugin in your favorite text editor. Next step is to point the eslint config to the rules in this repo. To do that, clone the repo

git clone https://github.com/neofonie/eslint-config-neofonie.git

and point the config to

1. For ES5 and below <path to repo>/eslint-config-neofonie/legacy.js
2. ES6 included <path to repo>/eslint-config-neofonie/index.js

For example, in Sublime Text editor add the below in SublimeLinter.sublime-settings file

"linters": {
        "eslint": {
            "@disable": false,
            "args": [
                "-c",
                "/Users/someUser/eslint-config-neofonie/index.js"
            ],
            "excludes": []
        }
  }