fix(eslint): upgrade eslint config for prettier

liangchunn · Mar 31, 2021 · 6b64b84 · 6b64b84
1 parent 0299442
commit 6b64b84
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 4 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -2,8 +2,7 @@
     "parser": "babel-eslint",
     "extends": [
         "eslint:recommended",
-        "plugin:prettier/recommended",
-        "prettier"
+        "plugin:prettier/recommended"
     ],
     "plugins": [
         "import"
@@ -35,8 +34,6 @@
             },
             "extends": [
                 "plugin:@typescript-eslint/recommended",
-                "prettier",
-                "prettier/@typescript-eslint",
                 "plugin:prettier/recommended"
             ],
             "plugins": [

diff --git a/docs/adding-prettier.md b/docs/adding-prettier.md
@@ -5,6 +5,8 @@ title: Adding Prettier
 
 ## Adding Prettier Into Your Project
 
+
+### Version `<4.1.0`
 > This feature is available starting from version 3 of `typescript-node-scripts`
 
 1. In your project folder, install Prettier and the ESLint plugins:
@@ -41,3 +43,37 @@ yarn add prettier eslint-plugin-prettier eslint-config-prettier --dev
   ]
 }
 ```
+
+### Version `>=4.1.0`
+
+1. In your project folder, install Prettier and the ESLint plugins:
+
+```sh
+# npm
+npm i -D prettier eslint-plugin-prettier eslint-config-prettier
+
+# yarn
+yarn add prettier eslint-plugin-prettier eslint-config-prettier --dev
+```
+
+2. Add the plugins to your `.eslintrc.json`
+
+```diff
+{
+  "parser": "babel-eslint",
+  "extends": [
+    "eslint:recommended",
++   "plugin:prettier/recommended"
+  ],
+  ...
+  "overrides": [
+    {
+      ...
+      "extends": [
+        "plugin:@typescript-eslint/recommended",
++       "plugin:prettier/recommended"
+      ],
+    }
+  ]
+}
+```