eslint-config-vazco

eslint-config-vazco

ESLint shareable config with rules used by Vazco.eu in Meteor/React projects

Install

For ESLint 3.x

To install simply add this config (along with ESLint and required dependencies) to your project dev-dependencies:

npm install --save-dev eslint
npm install --save-dev babel-eslint
npm install --save-dev eslint-config-vazco
npm install --save-dev eslint-plugin-babel
npm install --save-dev eslint-plugin-react
npm install --save-dev eslint-plugin-vazco
npm install --save-dev eslint-plugin-brackets

Ready to use one-liner:

npm i -D eslint babel-eslint eslint-config-vazco eslint-plugin-babel eslint-plugin-react eslint-plugin-vazco eslint-plugin-brackets

For ESLint 2.x (legacy)

If you want to use this config with ESLint 2.x (required e.g. for Node 0.10) you can install previous major version:

npm install --save-dev eslint@2 eslint-config-vazco@1 babel-eslint@6 eslint-plugin-babel@3 eslint-plugin-react@5

Usage

Extend your project ESLint rules with our config. This can be done in few ways:

.eslintrc / .eslintrc.json

{
    "extends": "vazco",
    "rules": {
        // custom project rules
    }
}

.eslintrc.yaml

extends:
  - vazco

rules:
  // custom project rules

package.json

{
    "eslintConfig": {
        "extends": "vazco"
    }
}

Changelog

All changes introduces in the config are tracked inside changelog file.

How to change the rules

All information regarding making changes in the config and versioning details can be found in contributing file.

Please read them before opening a Pull Request or suggesting a change.

Licence

MIT. Copyright (c) Vazco.eu.

Changelog

2.4.1

• Relaxed rules:

  • use brackets/object-curly-newline instead of object-curly-newline (#29)

• Updated dependencies:

  • eslint@3.18.0
  • babel-eslint@7.2.1
  • eslint-plugin-react@6.10.3