walmartlabseslint-config-defaults
A composable set of ESLint configurations.
Installation
Install this config package and ESLint:
$ npm install --save-dev eslint eslint-config-defaultsUsage
Full Configurations
This package includes the following complete and ready to use configurations:
defaults- The config recommended by ESLintdefaults/configurations/eslint- The config recommended by ESLintdefaults/configurations/google- The Google JavaScript Style Guidedefaults/configurations/gulp- The Gulp ESLint configdefaults/configurations/node-runtime- The config used for the Node.js runtimedefaults/configurations/off- Disable all rules (ESLint's default at 1.0.0+)defaults/configurations/airbnb/es5- Config from the AirBnB Style Guidedefaults/configurations/airbnb/es6-react- Config from the AirBnB Style Guidedefaults/configurations/airbnb/es6- Config from the AirBnB Style Guidedefaults/configurations/walmart/es5-browser- Walmart ES5 + browserdefaults/configurations/walmart/es5-node- Walmart ES5 + node < 4.xdefaults/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 + node 4.xdefaults/configurations/walmart/es6-react-test- Walmart ES6 + react + testdefaults/configurations/walmart/es6-react- Walmart ES6 + reactdefaults/configurations/walmart/es6-test- Walmart ES6 + testdefaults/configurations/walmart/es6- Walmart ES6 config
Dependencies
- Any Walmart config (
defaults/configurations/walmart/<suffix>) - eslint-plugin-filenames - Any React config (
<prefix>-react) - eslint-plugin-react, babel-eslint - Any ES-next config (
es6-<suffix>) - 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 https://github.com/walmartlabs/eslint-config-defaults/issues/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/node/off"
"env":
"phantom": trueLimitations
Due to an issue with ESLint, config extension cannot be called from a globally installed (npm install -g eslint) eslint. It can however be run properly using eslint installed directly to your package's node_modules. This can be done by either calling it directly (./node_modules/.bin/eslint .) or from within an npm script since they automatically check local node_modules first. This will be tracked in issue #43.
This package tracks config in the following versions:
- ESLint 1.10.3
- eslint-plugin-react 3.12.0
- eslint-config-airbnb 5.0.0
- eslint-config-gulp 2.0.0
- Google JavaScript Style Guide 43d738ab8b
- eslint-plugin-filenames 0.2.0
- Node.js a84bf2ce68a1ffd5c09c9ff297a56814cd79923f
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
- ES-Next Compat Table for the excellent docs on node features