From d30055c5b541d215287b8ff2187f8768dfbba7bc Mon Sep 17 00:00:00 2001 From: Jed Fox Date: Mon, 21 Jan 2019 07:28:52 -0500 Subject: [PATCH 1/4] docs(eslint-plugin): add docs on using Prettier with the plugin --- packages/eslint-plugin/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index ec96819a455f..06cfcc92dcbe 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -51,6 +51,18 @@ You can also enable all the recommended rules at once. Add `plugin:@typescript-e } ``` +💡 Using [Prettier](https://prettier.io)? Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) to disable our file rules: + +```json +{ + "extends": [ + "plugin:@typescript-eslint/recommended", + "prettier", + "prettier/typescript" + ] +} +``` + ## Supported Rules From 0e12ffe84aff5cb5343f423850a1e3bed88bc10a Mon Sep 17 00:00:00 2001 From: James Henry Date: Mon, 21 Jan 2019 09:20:16 -0500 Subject: [PATCH 2/4] Fix typo Co-Authored-By: j-f1 --- packages/eslint-plugin/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 06cfcc92dcbe..1a298577a51f 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -51,7 +51,7 @@ You can also enable all the recommended rules at once. Add `plugin:@typescript-e } ``` -💡 Using [Prettier](https://prettier.io)? Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) to disable our file rules: +💡 Using [Prettier](https://prettier.io)? Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) to disable our code formatting related rules: ```json { From 0325fd6d106202faadd701c60d15031b74773351 Mon Sep 17 00:00:00 2001 From: Jed Fox Date: Tue, 22 Jan 2019 12:51:42 -0500 Subject: [PATCH 3/4] docs: update instructions --- packages/eslint-plugin/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 1a298577a51f..fab18eb4909e 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -58,11 +58,13 @@ You can also enable all the recommended rules at once. Add `plugin:@typescript-e "extends": [ "plugin:@typescript-eslint/recommended", "prettier", - "prettier/typescript" + "prettier/@typescript-eslint" ] } ``` +*Note: Make sure you have `eslint-config-prettier@4.0.0` or newer.* + ## Supported Rules From 9f8d0ef56f78b3c86c5c22a71c29d5627fc40282 Mon Sep 17 00:00:00 2001 From: James Henry Date: Wed, 30 Jan 2019 08:18:03 -0500 Subject: [PATCH 4/4] fix formatting --- packages/eslint-plugin/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index eeec67f4d444..f0c11446353e 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -82,7 +82,7 @@ Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-pre } ``` -*Note: Make sure you have `eslint-config-prettier@4.0.0` or newer.* +**Note: Make sure you have `eslint-config-prettier@4.0.0` or newer.** ## Supported Rules