Skip to content

Commit

Permalink
fix: Restore instructions for required dependencies (#234)
Browse files Browse the repository at this point in the history
  • Loading branch information
iamturns committed Aug 23, 2021
1 parent f2422a6 commit 4d337f2
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,26 @@ Enhances Airbnb's ESLint config with TypeScript support

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.

### 2) Install this config (and peer dependencies)
### 2) Install dependencies

```bash
npm install eslint-config-airbnb-typescript \
@typescript-eslint/eslint-plugin \
@typescript-eslint/parser \
eslint-plugin-import@^2.22.0 \
eslint-plugin-jsx-a11y@^6.3.1 \
eslint-plugin-react@^7.20.3 \
eslint-plugin-react-hooks@^4.0.8 \
--save-dev
```

If you don't need React support:

```bash
npm install eslint-config-airbnb-typescript \
@typescript-eslint/eslint-plugin \
@typescript-eslint/parser \
eslint-plugin-import@^2.22.0 \
--save-dev
```

Expand Down Expand Up @@ -94,7 +108,7 @@ parserOptions: {

### Why do I need the peer dependencies?

`@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).
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).

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

Expand Down

0 comments on commit 4d337f2

Please sign in to comment.