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

Commit a763123

Browse files
authored
chore: Simplify dependency listing in README.md
We do not need to list peer dependencies already installed by the Airbnb config.
1 parent 6dbb849 commit a763123

File tree

1 file changed

+2
-16
lines changed

1 file changed

+2
-16
lines changed

README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,12 @@ 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 dependencies
13+
### 2) Install dependencies (and peer dependencies)
1414

1515
```bash
1616
npm install eslint-config-airbnb-typescript \
1717
@typescript-eslint/eslint-plugin@^4.4.1 \
1818
@typescript-eslint/parser@^4.4.1 \
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@^4.4.1 \
31-
@typescript-eslint/parser@^4.4.1 \
32-
eslint-plugin-import@^2.22.0 \
3319
--save-dev
3420
```
3521

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

10995
### Why do I need the peer dependencies?
11096

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).
97+
`@typescript-eslint/eslint-plugin` is a peer dependency 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).
11298

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

0 commit comments

Comments
 (0)