eslint-config-defaults

A composable set of ESLint configurations.

Installation

Install this config package and ESLint:

$ npm install --save-dev eslint eslint-config-defaults

Usage

Full Configurations

This package includes the following complete and ready to use configurations:

defaults - The config recommended by ESLint
defaults/configurations/airbnb - Config from the AirBnB Style Guide
defaults/configurations/google - The Google JavaScript Style Guide
defaults/configurations/eslint - The config recommended by ESLint
defaults/configurations/off - Disable all rules (ESLint's default at 1.0.0+)
defaults/configurations/walmart/es5-browser - Walmart ES5 + browser
defaults/configurations/walmart/es5-node - Walmart ES5 + node
defaults/configurations/walmart/es5-test - Walmart ES5 + test
defaults/configurations/walmart/es5 - Walmart ES5 config
defaults/configurations/walmart/es6-browser - Walmart ES6 + browser
defaults/configurations/walmart/es6-node - Walmart ES6 + node
defaults/configurations/walmart/es6-react-test - Walmart ES6 + react + test
defaults/configurations/walmart/es6-react - Walmart ES6 + react
defaults/configurations/walmart/es6-test - Walmart ES6 + test
defaults/configurations/walmart/es6 - Walmart ES6 config

Dependencies

AirBnB Config - eslint-plugin-react, babel-eslint
Any Walmart config (defaults/configurations/walmart/<suffix>) - eslint-plugin-filenames
Any React config (<prefix>-react) - eslint-plugin-react, babel-eslint

To consume and extend a config in ESLint just add the extends attribute to your .eslintrc. For more details about how shareable configs work, see the ESLint documentation.

---
"extends":
  - "defaults"

---
"extends":
  - "defaults/configurations/walmart/es6-browser"

NOTE: Extending multiple complete configs can cause unexpected results, if you need to do this you should consider a piecemeal config as explained below. See walmartlabs#38 for details.

Piecemeal Configurations

ESLint configuration is broken apart in ./rules containing ESLint's rules and rules for specific ESLint plugins. The full set of ESLint rules (./rules/eslint) are broken into categories that mirror ESLint's documentation. Under each rule type there are sets of configuration as well as an off.js file which turns off every rule in the category.

Examples

---
"extends":
  - "defaults/rules/eslint/best-practices/walmart",
  - "defaults/rules/eslint/errors/airbnb"

  - "defaults/rules/eslint/es6/off"
  - "defaults/rules/eslint/legacy/off"
  - "defaults/rules/eslint/node/off"

"env":
  "phantom": true

This package tracks config in the following versions:

ESLint 1.5.1
eslint-plugin-react 3.5.0
eslint-config-airbnb 0.0.7
Google JavaScript Style Guide 43d738ab8b
eslint-plugin-filenames 0.1.2

And A Special Thanks To

Nicholas C. Zakas for all the amazing work on ESLint
Keith Cirkel for painstakingly formatting all of ESLint's rules into JSON in eslint-config-strict
AirBnB for sharing all of their config in JavaScript Style Guide
Google for sharing their styleguide

License

MIT License

heskew / eslint-config-defaults Goto Github PK