From e76c922944fe49f7001f30dac84f573e052f68e9 Mon Sep 17 00:00:00 2001 From: Borek Bernard Date: Wed, 5 Jun 2019 09:02:03 +0200 Subject: [PATCH 1/3] docs(eslint-plugin): Add eslint:recommended to a usage example --- packages/eslint-plugin/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 6b605d31b57b..476639c5d871 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -47,7 +47,10 @@ You can also enable all the recommended rules at once. Add `plugin:@typescript-e ```json { - "extends": ["plugin:@typescript-eslint/recommended"] + "extends": [ + "// eslint:recommended, ...", + "plugin:@typescript-eslint/recommended" + ] } ``` From 86ae914a77adc48af7065ff85f426816fc90cc12 Mon Sep 17 00:00:00 2001 From: Borek Bernard Date: Wed, 5 Jun 2019 16:31:38 +0200 Subject: [PATCH 2/3] docs(eslint-plugin): use comment in JSON via 'jsonc' --- packages/eslint-plugin/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 476639c5d871..c96e8f776749 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -45,10 +45,10 @@ Then configure the rules you want to use under the rules section. You can also enable all the recommended rules at once. Add `plugin:@typescript-eslint/recommended` in extends: -```json +```jsonc { "extends": [ - "// eslint:recommended, ...", + // ... other rule sets like 'eslint:recommended' ... "plugin:@typescript-eslint/recommended" ] } From 2e6f60e437902ada4510b154fa36f5502e618b73 Mon Sep 17 00:00:00 2001 From: Borek Bernard Date: Thu, 6 Jun 2019 10:02:28 +0200 Subject: [PATCH 3/3] docs(eslint-plugin): usage of eslint:recommended --- packages/eslint-plugin/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index c96e8f776749..87e8cfd72ee1 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -43,12 +43,21 @@ Then configure the rules you want to use under the rules section. } ``` -You can also enable all the recommended rules at once. Add `plugin:@typescript-eslint/recommended` in extends: +You can also enable all the recommended rules for our plugin. Add `plugin:@typescript-eslint/recommended` in extends: -```jsonc +```json +{ + "extends": ["plugin:@typescript-eslint/recommended"] +} +``` + +You can also use [eslint:recommended](https://eslint.org/docs/rules/) with this plugin. Add both `eslint:recommended` and `plugin:@typescript-eslint/eslint-recommended`: + +```json { "extends": [ - // ... other rule sets like 'eslint:recommended' ... + "eslint:recommended", + "plugin:@typescript-eslint/eslint-recommended", "plugin:@typescript-eslint/recommended" ] }