From 7c1e8e4818f1adc2bca1f84e05d78e2b5e274678 Mon Sep 17 00:00:00 2001 From: Erik Demaine Date: Sun, 25 Apr 2021 09:40:01 -0400 Subject: [PATCH] [Docs] Add import/recommended ruleset to README Fixes #2032 --- CHANGELOG.md | 3 +++ README.md | 5 +++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 645018580..4c6740ef4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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 @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index 7945546a6..8ee4dedd4 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 ```