README.md

eslint-config-zeal

A shareable ESLint config for Zeal's coding style.

Zeal's JavaScript coding style is still evolving as we do more projects, but this represents our current thinking. After it stabilizes more, we'll release a version 1.0.

Install

NOTE: The current version of this package is designed to work with ESLint 2.0 and greater. If you are still using ESLint 1.x, use version 0.2.0 of this package instead.

To make use of this configuration, install eslint, babel-eslint, eslint-plugin-import, and this package as development dependencies of your project:

npm install eslint babel-eslint eslint-plugin-import eslint-config-zeal --save-dev

These packages are marked as peer dependencies, so you will get a warning if they're not installed.

Usage

Add this to your .eslintrc file:

{
  "extends": "zeal"
}

Note: ESLint assumes the eslint-config- prefix, so we can omit it.

You can override settings from the configuration(s) by adding them directly to your .eslintrc file.

We have added some additional optional configurations that you can add on top of the base zeal config:

• zeal/react: Adds rules for React development. You'll need to install eslint-plugin-react to use this configuration.
• zeal/mocha: Overrides rules for use with Mocha. We recommend creating a separate .eslintrc file in the directory containing your tests and extending this config there.
• zeal/chai: Overrides rules for use with Chai. We recommend creating a separate .eslintrc file in the directory containing your tests and extending this config there.

You can extend multiple configurations using an array:

{
  "extends": ["zeal", "zeal/react"]
}

See the ESLint configuration documentation for more information on configuring ESLint.

Usage With React

If you're using this package in a React project, make sure you have eslint-plugin-react installed as well:

npm install eslint-plugin-react --save-dev

Then, in your .eslintrc file, extend both the zeal and zeal/react configurations:

{
  "extends": ["zeal", "zeal/react"]
}

Usage With Webpack

This configuration uses eslint-plugin-import. If your project uses Webpack, you'll need to add eslint-import-resolver-webpack:

npm install eslint-import-resolver-webpack

You'll also need to add the following to your .eslintrc:

"settings": {
  "import/resolver": "webpack"
}

or, if your webpack config file is not in the default location:

"settings": {
  "import/resolver": {
    "webpack": { "config": "path/to/webpack.config.js" }
  }
}

Supported Versions

This plugin contains all of the rules available in:

• ESLint: 2.13.1
• eslint-plugin-react: 5.2.2
• eslint-plugin-import: 1.8.0

License

Copyright (c) 2016 Zeal, LLC. Licensed under the MIT license.