eslint-config-defaults

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

This package is made for:

• ESLint 1.0.0+
• eslint-plugin-react 3.1.0+
• eslint-config-airbnb 0.0.7
• eslint-plugin-filenames 0.1.2

Full Configurations

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

Note: Any React config <prefix>-react requires eslint-plugin-react

Note: Any Walmart config defaults/configurations/walmart/<suffix> requires eslint-plugin-filenames

• defaults - The default ESLint config
• defaults/configurations/airbnb - Config from the AirBnB Style Guide
• defaults/configurations/eslint - The default ESLint config
• defaults/configurations/off - Turns off all rules. This will be ESLint's default after 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 - Walmart ES6 + react
• defaults/configurations/walmart/es6-test - Walmart ES6 + test
• defaults/configurations/walmart/es6 - Walmart ES6 config

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

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

---

License

MIT License

Changelog

4.1.0 (2015-08-17)

User Facing Changes

• Add filename enforcement plugin to Walmart configs