feat(linting): restrict direct use of supersetTheme in favor of Theme…

…Provider (#17001) * feat: restrict direct use of supersetTheme * allowing a couple of safe instances of supersetTheme
apache · Oct 7, 2021 · 5f73ca8 · 5f73ca8
1 parent 66b0877
commit 5f73ca8
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 3 deletions.
diff --git a/superset-frontend/.eslintrc.js b/superset-frontend/.eslintrc.js
@@ -108,14 +108,20 @@ module.exports = {
         'no-prototype-builtins': 0,
         'no-restricted-properties': 0,
         'no-restricted-imports': [
-          'error',
+          'warn',
           {
             paths: [
               {
                 name: 'antd',
                 message:
                   'Please import Ant components from the index of common/components',
               },
+              {
+                name: '@superset-ui/core',
+                importNames: ['supersetTheme'],
+                message:
+                  'Please use the theme directly from the ThemeProvider rather than importing supersetTheme.',
+              },
             ],
           },
         ],

diff --git a/superset-frontend/spec/helpers/theming.ts b/superset-frontend/spec/helpers/theming.ts
@@ -17,6 +17,7 @@
  * under the License.
  */
 import { shallow as enzymeShallow, mount as enzymeMount } from 'enzyme';
+// eslint-disable-next-line no-restricted-imports
 import { supersetTheme } from '@superset-ui/core';
 import { ReactElement } from 'react';
 import { ProviderWrapper } from './ProviderWrapper';

diff --git a/superset-frontend/src/common/components/.eslintrc b/superset-frontend/src/common/components/.eslintrc
@@ -18,6 +18,17 @@
  */
 {
   "rules": {
-    "no-restricted-imports": 0
+    "no-restricted-imports": [
+      "warn",
+      {
+        "paths": [
+          {
+              "name": "@superset-ui/core",
+              "importNames": ["supersetTheme"],
+              "message": "Please use the theme directly from the ThemeProvider rather than importing supersetTheme."
+          }
+        ]
+      }
+    ]
   }
 }
diff --git a/superset-frontend/src/components/.eslintrc b/superset-frontend/src/components/.eslintrc
@@ -18,6 +18,19 @@
  */
 {
   "rules": {
-    "no-restricted-imports": 0
+    "no-restricted-imports": [
+      "warn",
+      {
+        "paths": [
+          {
+            "name": "@superset-ui/core",
+            "importNames": [
+              "supersetTheme"
+            ],
+            "message": "Please use the theme directly from the ThemeProvider rather than importing supersetTheme."
+          }
+        ]
+      }
+    ]
   }
 }
diff --git a/superset-frontend/src/preamble.ts b/superset-frontend/src/preamble.ts
@@ -19,6 +19,7 @@
 import { setConfig as setHotLoaderConfig } from 'react-hot-loader';
 import 'abortcontroller-polyfill/dist/abortcontroller-polyfill-only';
 import moment from 'moment';
+// eslint-disable-next-line no-restricted-imports
 import { configure, supersetTheme } from '@superset-ui/core';
 import { merge } from 'lodash';
 import setupClient from './setup/setupClient';