fix: 🐛 fix setup without prettier. Updated readme

dipiash · Sep 15, 2023 · 59d1c51 · 59d1c51
1 parent 35f04dc
commit 59d1c51
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -38,41 +38,53 @@ npx install-peerdeps eslint-plugin-nimbus-clean
 
 ### Usage
 
-Add `nimbus-clean` to the extends or plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
-
-```json
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 13,
-    "sourceType": "module",
-    "ecmaFeatures": {
-      "jsx": true,
-      "modules": true,
-      "experimentalObjectRestSpread": true
+1. Add `nimbus-clean` to the extends or plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+   ```json
+   {
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "ecmaVersion": 13,
+        "sourceType": "module",
+        "ecmaFeatures": {
+          "jsx": true,
+          "modules": true,
+          "experimentalObjectRestSpread": true
+        }
+      },
+      "ignorePatterns": [
+        "**/*",
+        "node_modules"
+      ],
+      "settings": {
+        "react": {
+          "pragma": "React",
+          "fragment": "Fragment",
+          "version": "detect"
+        },
+        "import/resolver": {
+          "typescript": {
+            "alwaysTryTypes": true
+          }
+        }
+      },
+      "extends": [
+        "plugin:nimbus-clean/recommended"
+      ],
+      "plugins": [
+        "nimbus-clean"
+      ]
     }
-  },
-  "ignorePatterns": [
-    "**/*",
-    "node_modules"
-  ],
-  "settings": {
-    "react": {
-      "pragma": "React",
-      "fragment": "Fragment",
-      "version": "detect"
-    },
-    "import/resolver": {
-      "typescript": {
-        "alwaysTryTypes": true
-      }
+    ```
+
+2. If you don't have a `.prettierrc` config, please add it
+
+    ```prettier
+    {
+      "singleQuote": true,
+      "printWidth": 150,
+      "useTabs": false,
+      "tabWidth": 2,
+      "trailingComma": "all",
+      "semi": false
     }
-  },
-  "extends": [
-    "plugin:nimbus-clean/recommended"
-  ],
-  "plugins": [
-    "nimbus-clean"
-  ]
-}
-```
+    ```
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -65,6 +65,7 @@
     "eslint-plugin-sonarjs": "^0.20.0",
     "eslint-plugin-testing-library": "^6.0.0",
     "eslint-plugin-unicorn": "^48.0.1",
+    "prettier": "^3.0.3",
     "husky": "^8.0.3",
     "markdown-toc": "^1.2.0",
     "npm-run-all": "^4.1.5",
@@ -89,7 +90,8 @@
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "eslint-plugin-sonarjs": "^0.20.0",
     "eslint-plugin-testing-library": "^6.0.0",
-    "eslint-plugin-unicorn": "^48.0.1"
+    "eslint-plugin-unicorn": "^48.0.1",
+    "prettier": "^3.0.3"
   },
   "peerDependenciesMeta": {
     "eslint": {
@@ -142,6 +144,9 @@
     },
     "eslint-plugin-perfectionist": {
       "optional": false
+    },
+    "prettier": {
+      "optional": false
     }
   }
 }