Skip to content
This repository was archived by the owner on May 12, 2025. It is now read-only.

Commit 4d337f2

Browse files
authored
fix: Restore instructions for required dependencies (#234)
1 parent f2422a6 commit 4d337f2

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,26 @@ Enhances Airbnb's ESLint config with TypeScript support
1010

1111
Make sure you have the regular Airbnb config setup. See [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb), or [eslint-config-airbnb-base](https://www.npmjs.com/package/eslint-config-airbnb-base) if you're not using React.
1212

13-
### 2) Install this config (and peer dependencies)
13+
### 2) Install dependencies
1414

1515
```bash
1616
npm install eslint-config-airbnb-typescript \
1717
@typescript-eslint/eslint-plugin \
1818
@typescript-eslint/parser \
19+
eslint-plugin-import@^2.22.0 \
20+
eslint-plugin-jsx-a11y@^6.3.1 \
21+
eslint-plugin-react@^7.20.3 \
22+
eslint-plugin-react-hooks@^4.0.8 \
23+
--save-dev
24+
```
25+
26+
If you don't need React support:
27+
28+
```bash
29+
npm install eslint-config-airbnb-typescript \
30+
@typescript-eslint/eslint-plugin \
31+
@typescript-eslint/parser \
32+
eslint-plugin-import@^2.22.0 \
1933
--save-dev
2034
```
2135

@@ -94,7 +108,7 @@ parserOptions: {
94108

95109
### Why do I need the peer dependencies?
96110

97-
`@typescript-eslint/eslint-plugin` is a peer dependency because of a limitation within ESLint. See [issue](https://github.com/eslint/eslint/issues/3458), [RFC](https://github.com/eslint/rfcs/tree/master/designs/2019-config-simplification), and [progress](https://github.com/eslint/eslint/issues/13481).
111+
The ESLint plugins are peer dependencies due to a limitation within ESLint. See [issue](https://github.com/eslint/eslint/issues/3458), [RFC](https://github.com/eslint/rfcs/tree/master/designs/2019-config-simplification), and [progress](https://github.com/eslint/eslint/issues/13481).
98112

99113
`@typescript-eslint/parser` is a peer dependency because the version number must match `@typescript-eslint/eslint-plugin`.
100114

0 commit comments

Comments
 (0)