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 default ESLint configdefaults/configurations/airbnb
- Config from the AirBnB Style Guidedefaults/configurations/google
- The Google JavaScript Style Guidedefaults/configurations/eslint
- The default ESLint configdefaults/configurations/off
- Disable all rules (ESLint's default at 1.0.0+)defaults/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 + reactdefaults/configurations/walmart/es6-test
- Walmart ES6 + testdefaults/configurations/walmart/es6
- Walmart ES6 config
Dependencies
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 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:
And A Special Thanks To
License
MIT License