Skip to content

Commit

Permalink
[Docs] Add import/recommended ruleset to README
Browse files Browse the repository at this point in the history
Fixes #2032
  • Loading branch information
edemaine authored and ljharb committed Apr 25, 2021
1 parent a943fd0 commit 7c1e8e4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Expand Up @@ -38,6 +38,7 @@ This change log adheres to standards from [Keep a CHANGELOG](http://keepachangel
- [Docs] `no-extraneous-dependencies`: correct peerDependencies option default to `true` ([#1993], thanks [@dwardu])
- [Docs] `order`: Document options required to match ordering example ([#1992], thanks [@silviogutierrez])
- [Tests] `no-unresolved`: add tests for `import()` ([#2012], thanks [@davidbonnet])
- [Docs] Add import/recommended ruleset to README ([#2034], thanks [@edemaine])

## [2.22.1] - 2020-09-27
### Fixed
Expand Down Expand Up @@ -768,6 +769,7 @@ for info on changes for earlier releases.

[`memo-parser`]: ./memo-parser/README.md

[#2034]: https://github.com/benmosher/eslint-plugin-import/pull/2034
[#2026]: https://github.com/benmosher/eslint-plugin-import/pull/2026
[#2022]: https://github.com/benmosher/eslint-plugin-import/pull/2022
[#2021]: https://github.com/benmosher/eslint-plugin-import/pull/2021
Expand Down Expand Up @@ -1366,3 +1368,4 @@ for info on changes for earlier releases.
[@aladdin-add]: https://github.com/aladdin-add
[@davidbonnet]: https://github.com/davidbonnet
[@hayes]: https://github.com/hayes
[@edemaine]: https://github.com/edemaine
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -138,6 +138,8 @@ in your `.eslintrc.(yml|json|js)`, or extend one of the canned configs:
---
extends:
- eslint:recommended
- plugin:import/recommended
# alternatively, 'recommended' is the combination of these two rule sets:
- plugin:import/errors
- plugin:import/warnings

Expand All @@ -163,8 +165,7 @@ Make sure you have installed [`@typescript-eslint/parser`] which is used in the
```yaml
extends:
- eslint:recommended
- plugin:import/errors
- plugin:import/warnings
- plugin:import/recommended
- plugin:import/typescript # this line does the trick
```

Expand Down

0 comments on commit 7c1e8e4

Please sign in to comment.