Skip to content

Commit 266860b

Browse files
nathanhleungljharb
authored andcommitted
[eslint config] [*] [docs] add note about install-peerdeps
Closes airbnb#1233.
1 parent b484381 commit 266860b

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

packages/eslint-config-airbnb-base/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ Our default export contains all of our ESLint rules, including ECMAScript 6+. It
3232
npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.#
3333
```
3434

35+
Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool.
36+
37+
```sh
38+
npm install -g install-peerdeps
39+
install-peerdeps --dev eslint-config-airbnb-base
40+
```
41+
42+
The cli will produce and run a command like:
43+
44+
```sh
45+
npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.#
46+
```
47+
3548
2. Add `"extends": "airbnb-base"` to your .eslintrc
3649

3750
### eslint-config-airbnb-base/legacy

packages/eslint-config-airbnb/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,19 @@ Our default export contains all of our ESLint rules, including ECMAScript 6+ and
3333
npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
3434
```
3535

36+
Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool.
37+
38+
```sh
39+
npm install -g install-peerdeps
40+
install-peerdeps --dev eslint-config-airbnb
41+
```
42+
43+
The cli will produce and run a command like:
44+
45+
```sh
46+
npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
47+
```
48+
3649
2. Add `"extends": "airbnb"` to your .eslintrc
3750

3851
### eslint-config-airbnb/base

0 commit comments

Comments
 (0)