Skip to content

Commit b42e9b8

Browse files
author
Jake Teton-Landis
committed
explain eslint-config-airbnb rule choices
1 parent 170dbeb commit b42e9b8

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

packages/eslint-config-airbnb/README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,30 @@ This package provides Airbnb's .eslintrc as an extensible shared config.
44

55
## Usage
66

7-
### With React Style
7+
We export three ESLint configurations for your usage.
88

9-
1. `npm install --save-dev eslint-config-airbnb babel-eslint eslint-plugin-react`
9+
### eslint-config-airbnb
10+
11+
Our default export contains all of our ESLint rules, including EcmaScript 6+
12+
and React. It requires `eslint`, `babel-eslint`, and `eslint-plugin-react`.
13+
14+
1. `npm install --save-dev eslint-config-airbnb babel-eslint eslint-plugin-react eslint`
1015
2. add `"extends": "airbnb"` to your .eslintrc
1116

12-
### Without React Style
17+
### eslint-config-airbnb/base
18+
19+
Lints ES6+ but does not lint React. Requires `eslint` and `babel-eslint`.
1320

14-
1. `npm install --save-dev eslint-config-airbnb babel-eslint `
21+
1. `npm install --save-dev eslint-config-airbnb babel-eslint eslint`
1522
2. add `"extends": "airbnb/base"` to your .eslintrc
1623

24+
### eslint-config-airbnb/legacy
25+
26+
Lints ES5 and below. Only requires `eslint`.
27+
28+
1. `npm install --save-dev eslint-config-airbnb eslint`
29+
2. add `"extends": "airbnb/legacy"` to your .eslintrc
30+
1731
See [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript) and
1832
the [ESlint config docs](http://eslint.org/docs/user-guide/configuring#extending-configuration-files)
1933
for more information.

0 commit comments

Comments
 (0)