eslint-config-defaults
A composable set of ESLint configurations.
Installation
Install this config package and ESLint:
$ npm install --save-dev eslint-config-defaults
Usage
This package is made for for ESLint 0.24.0+
Full Configurations
This package includes the following complete and ready to use configurations:
defaults
- The default ESLint configdefaults/configurations/eslint
- The default ESLint configdefaults/configurations/airbnb
- Config from the AirBnB Style Guidedefaults/configurations/walmart/es5-browser
- Walmart ES5 + browserdefaults/configurations/walmart/es5-node
- Walmart ES5 + nodedefaults/configurations/walmart/es5-test
- Walmart ES5 + testdefaults/configurations/walmart/es5
- Walmart ES5 configdefaults/configurations/walmart/es6-browser
- Walmart ES6 + browserdefaults/configurations/walmart/es6-node
- Walmart ES6 + nodedefaults/configurations/walmart/es6-react
- Walmart ES6 + react (requires eslint-plugin-react)defaults/configurations/walmart/es6-test
- Walmart ES6 + testdefaults/configurations/walmart/es6
- Walmart ES6 configdefaults/configurations/off
- Turns off all rules. This will be ESLint's default after 1.0.0
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"
Piecemeal Configurations
ESLint configuration is broken into two parts: rules
and environments
-
Rules - The full set of ESLint rules are included in the project broken into categories that
mirror the documentation. Under each rule type there are sets of configuration as well as an
off.js
file which turns off every rule in this category.
-
Environments - Environments are a collection of modifiers that amend a set of generic rules to run
in specific environments like browser
or node
.
Examples
---
"extends":
- "defaults/configurations/walmart/es6",
- "defaults/environments/browser"
---
"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
License
MIT License