feat: all rebass components considered as global variables

mdx-js · Aug 11, 2019 · a36a69b · a36a69b
1 parent e59cbdc
commit a36a69b
Show file tree

Hide file tree

Showing 7 changed files with 415 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -64,21 +64,29 @@ npm i -D @rxts/eslint-plugin-mdx
 
    2. If you're using `eslint@^5.0.0`, you need to enable this parser/plugin manually, because `eslint@5` does not support `extends` for `overrides` property in its configuration:
 
-      ```json
-      {
-        "extends": ["plugin:@rxts/mdx/recommended"],
-        "overrides": [
+      ```js
+      const rebass = require('rebass')
+
+      module.exports = {
+        extends: ['plugin:@rxts/mdx/recommended'],
+        overrides: [
           {
-            "files": ["*.mdx"],
-            "globals": {
-              "React": false
+            files: ['*.mdx'],
+            globals: Object.keys(rebass).reduce(
+              (globals, Component) =>
+                Object.assign(globals, {
+                  [Component]: false,
+                }),
+              {
+                React: false,
+              },
+            ),
+            rules: {
+              'lines-between-class-members': 0,
+              'react/react-in-jsx-scope': 0,
             },
-            "rules": {
-              "lines-between-class-members": 0,
-              "react/react-in-jsx-scope": 0
-            }
-          }
-        ]
+          },
+        ],
       }
       ```
 

diff --git a/package.json b/package.json
@@ -21,6 +21,7 @@
     "@types/jest": "^24.0.17",
     "@types/node": "^12.7.1",
     "@types/react": "^16.9.1",
+    "@types/rebass": "^3.0.4",
     "@types/unist": "^2.0.3",
     "babel-eslint": "^10.0.2",
     "commitlint": "^8.1.0",

diff --git a/packages/eslint-mdx/README.md b/packages/eslint-mdx/README.md
@@ -64,21 +64,29 @@ npm i -D @rxts/eslint-plugin-mdx
 
    2. If you're using `eslint@^5.0.0`, you need to enable this parser/plugin manually, because `eslint@5` does not support `extends` for `overrides` property in its configuration:
 
-      ```json
-      {
-        "extends": ["plugin:@rxts/mdx/recommended"],
-        "overrides": [
+      ```js
+      const rebass = require('rebass')
+
+      module.exports = {
+        extends: ['plugin:@rxts/mdx/recommended'],
+        overrides: [
           {
-            "files": ["*.mdx"],
-            "globals": {
-              "React": false
+            files: ['*.mdx'],
+            globals: Object.keys(rebass).reduce(
+              (globals, Component) =>
+                Object.assign(globals, {
+                  [Component]: false,
+                }),
+              {
+                React: false,
+              },
+            ),
+            rules: {
+              'lines-between-class-members': 0,
+              'react/react-in-jsx-scope': 0,
             },
-            "rules": {
-              "lines-between-class-members": 0,
-              "react/react-in-jsx-scope": 0
-            }
-          }
-        ]
+          },
+        ],
       }
       ```
 

diff --git a/packages/eslint-plugin-mdx/README.md b/packages/eslint-plugin-mdx/README.md
@@ -64,21 +64,29 @@ npm i -D @rxts/eslint-plugin-mdx
 
    2. If you're using `eslint@^5.0.0`, you need to enable this parser/plugin manually, because `eslint@5` does not support `extends` for `overrides` property in its configuration:
 
-      ```json
-      {
-        "extends": ["plugin:@rxts/mdx/recommended"],
-        "overrides": [
+      ```js
+      const rebass = require('rebass')
+
+      module.exports = {
+        extends: ['plugin:@rxts/mdx/recommended'],
+        overrides: [
           {
-            "files": ["*.mdx"],
-            "globals": {
-              "React": false
+            files: ['*.mdx'],
+            globals: Object.keys(rebass).reduce(
+              (globals, Component) =>
+                Object.assign(globals, {
+                  [Component]: false,
+                }),
+              {
+                React: false,
+              },
+            ),
+            rules: {
+              'lines-between-class-members': 0,
+              'react/react-in-jsx-scope': 0,
             },
-            "rules": {
-              "lines-between-class-members": 0,
-              "react/react-in-jsx-scope": 0
-            }
-          }
-        ]
+          },
+        ],
       }
       ```
 

diff --git a/packages/eslint-plugin-mdx/package.json b/packages/eslint-plugin-mdx/package.json
@@ -22,6 +22,7 @@
     "eslint-plugin-react": ">=7.0.0"
   },
   "dependencies": {
-    "eslint-mdx": "^0.10.0"
+    "eslint-mdx": "^0.10.0",
+    "rebass": "^4.0.2"
   }
 }
diff --git a/packages/eslint-plugin-mdx/src/configs/overrides.ts b/packages/eslint-plugin-mdx/src/configs/overrides.ts
@@ -1,10 +1,18 @@
 import { base } from './base'
 
+import * as rebass from 'rebass'
+
 export const overrides = {
   ...base,
-  globals: {
-    React: false,
-  },
+  globals: Object.keys(rebass).reduce<Record<string, false>>(
+    (globals, Component) =>
+      Object.assign(globals, {
+        [Component]: false,
+      }),
+    {
+      React: false,
+    },
+  ),
   rules: {
     'lines-between-class-members': 0, // See /~https://github.com/mdx-js/mdx/issues/195
     'react/react-in-jsx-scope': 0,