docs: add note about babel and monorepo

moxystudio · Oct 9, 2020 · 4cd2555 · 4cd2555
1 parent ed6a9d1
commit 4cd2555
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 15 deletions.
diff --git a/__snapshots__/index.test.js.snap b/__snapshots__/index.test.js.snap
@@ -2388,12 +2388,6 @@ Array [
     "rule": "no-undef",
     "severity": 2,
   },
-  Object {
-    "column": 78,
-    "line": 43,
-    "rule": "react/prop-types",
-    "severity": 2,
-  },
   Object {
     "column": 15,
     "line": 49,

diff --git a/packages/eslint-config-babel/README.md b/packages/eslint-config-babel/README.md
@@ -39,3 +39,23 @@ This package should be used in conjunction with [`@moxy/eslint-config-base`](../
     ]
 }
 ```
+
+⚠️ If you are using a monorepo, you will need specify the `configFile` to point to the root:
+
+```json
+{
+    "root": true,
+    "env": {
+        "browser": true
+    },
+    "extends": [
+        "@moxy/eslint-config-base/esm",
+        "@moxy/eslint-config-babel"
+    ],
+    "parserOptions": {
+        "babelOptions": {
+          "configFile": "./.babelrc.json"
+        }
+    }
+}
+```
diff --git a/packages/eslint-config-base/README.md b/packages/eslint-config-base/README.md
@@ -62,10 +62,10 @@ All files that end in `.config.js` within your project root folder will **automa
     {
         "root": true,
         "env": {
-            "node": true,
+            "node": true
         },
         "extends": [
-            "@moxy/eslint-config-base/cjs/es2019",
+            "@moxy/eslint-config-base/cjs/es2019"
         ]
     }
     ```
@@ -76,7 +76,7 @@ All files that end in `.config.js` within your project root folder will **automa
     {
         "root": true,
         "env": {
-            "browser": true,
+            "browser": true
         },
         "extends": [
             "@moxy/eslint-config-base/esm",
@@ -91,10 +91,10 @@ All files that end in `.config.js` within your project root folder will **automa
         "root": true,
         "env": {
             "browser": true,
-            "node": true,
+            "node": true
         },
         "extends": [
-            "@moxy/eslint-config-base/esm",
+            "@moxy/eslint-config-base/esm"
         ]
     }
     ```

diff --git a/packages/eslint-config-jest/README.md b/packages/eslint-config-jest/README.md
@@ -34,7 +34,7 @@ This package should be used in conjunction with [`@moxy/eslint-config-base`](../
 {
     "root": true,
     "env": {
-        "browser": true,
+        "browser": true
     },
     "extends": [
         "@moxy/eslint-config-base/esm",

diff --git a/packages/eslint-config-react-web-a11y/README.md b/packages/eslint-config-react-web-a11y/README.md
@@ -31,7 +31,7 @@ This package should be used in conjunction with [`@moxy/eslint-config-base`](../
 {
     "root": true,
     "env": {
-        "browser": true,
+        "browser": true
     },
     "extends": [
         "@moxy/eslint-config-base/esm",

diff --git a/packages/eslint-config-react/README.md b/packages/eslint-config-react/README.md
@@ -31,7 +31,7 @@ This package should be used in conjunction with [`@moxy/eslint-config-base`](../
 {
     "root": true,
     "env": {
-        "browser": true,
+        "browser": true
     },
     "extends": [
         "@moxy/eslint-config-base/esm",

diff --git a/packages/eslint-config-vue/README.md b/packages/eslint-config-vue/README.md
@@ -31,7 +31,7 @@ This package should be used in conjunction with [`@moxy/eslint-config-base`](../
 {
     "root": true,
     "env": {
-        "browser": true,
+        "browser": true
     },
     "extends": [
         "@moxy/eslint-config-base/esm",