[eslint config] [*] [docs] add note about install-peerdeps

Closes #1233.
This commit is contained in:
nathanhleung
2017-01-06 17:04:28 -05:00
committed by Jordan Harband
parent b48438141c
commit 266860b597
2 changed files with 26 additions and 0 deletions

View File

@@ -32,6 +32,19 @@ Our default export contains all of our ESLint rules, including ECMAScript 6+. It
npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.#
```
Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool.
```sh
npm install -g install-peerdeps
install-peerdeps --dev eslint-config-airbnb-base
```
The cli will produce and run a command like:
```sh
npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.#
```
2. Add `"extends": "airbnb-base"` to your .eslintrc
### eslint-config-airbnb-base/legacy

View File

@@ -33,6 +33,19 @@ Our default export contains all of our ESLint rules, including ECMAScript 6+ and
npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
```
Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool.
```sh
npm install -g install-peerdeps
install-peerdeps --dev eslint-config-airbnb
```
The cli will produce and run a command like:
```sh
npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
```
2. Add `"extends": "airbnb"` to your .eslintrc
### eslint-config-airbnb/base