Skip to content

Commit 7c1e8e4

Browse files
edemaineljharb
authored andcommitted
[Docs] Add import/recommended ruleset to README
Fixes #2032
1 parent a943fd0 commit 7c1e8e4

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

Diff for: CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ This change log adheres to standards from [Keep a CHANGELOG](http://keepachangel
3838
- [Docs] `no-extraneous-dependencies`: correct peerDependencies option default to `true` ([#1993], thanks [@dwardu])
3939
- [Docs] `order`: Document options required to match ordering example ([#1992], thanks [@silviogutierrez])
4040
- [Tests] `no-unresolved`: add tests for `import()` ([#2012], thanks [@davidbonnet])
41+
- [Docs] Add import/recommended ruleset to README ([#2034], thanks [@edemaine])
4142

4243
## [2.22.1] - 2020-09-27
4344
### Fixed
@@ -768,6 +769,7 @@ for info on changes for earlier releases.
768769

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

772+
[#2034]: https://github.com/benmosher/eslint-plugin-import/pull/2034
771773
[#2026]: https://github.com/benmosher/eslint-plugin-import/pull/2026
772774
[#2022]: https://github.com/benmosher/eslint-plugin-import/pull/2022
773775
[#2021]: https://github.com/benmosher/eslint-plugin-import/pull/2021
@@ -1366,3 +1368,4 @@ for info on changes for earlier releases.
13661368
[@aladdin-add]: https://github.com/aladdin-add
13671369
[@davidbonnet]: https://github.com/davidbonnet
13681370
[@hayes]: https://github.com/hayes
1371+
[@edemaine]: https://github.com/edemaine

Diff for: README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ in your `.eslintrc.(yml|json|js)`, or extend one of the canned configs:
138138
---
139139
extends:
140140
- eslint:recommended
141+
- plugin:import/recommended
142+
# alternatively, 'recommended' is the combination of these two rule sets:
141143
- plugin:import/errors
142144
- plugin:import/warnings
143145

@@ -163,8 +165,7 @@ Make sure you have installed [`@typescript-eslint/parser`] which is used in the
163165
```yaml
164166
extends:
165167
- eslint:recommended
166-
- plugin:import/errors
167-
- plugin:import/warnings
168+
- plugin:import/recommended
168169
- plugin:import/typescript # this line does the trick
169170
```
170171

0 commit comments

Comments
 (0)