@hubspot/eslint-config-ui-extensions 0.12.0 → 1.1.0

package/dist/__tests__/rules/no-restricted-globals.spec.js

@@ -0,0 +1,434 @@
+import { RuleTester } from 'eslint';
+import tseslint from 'typescript-eslint';
+import { noRestrictedGlobals } from "../../rules/no-restricted-globals.js";
+import { languageOptions } from "../../runtime.js";
+const ruleTester = new RuleTester({
+    languageOptions: {
+        ...languageOptions,
+        parserOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            ecmaFeatures: {
+                jsx: true,
+            },
+        },
+    },
+});
+const tsRuleTester = new RuleTester({
+    languageOptions: {
+        ...languageOptions,
+        parser: tseslint.parser,
+        parserOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+        },
+    },
+});
+describe('no-restricted-globals', () => {
+    ruleTester.run('no-restricted-globals', noRestrictedGlobals, {
+        valid: [
+            {
+                name: 'allows importScripts as a local variable',
+                code: `
+          const importScripts = () => console.log('custom');
+          importScripts();
+        `,
+            },
+            {
+                name: 'allows addEventListener as a local variable',
+                code: `
+          const addEventListener = (event, handler) => {};
+          addEventListener('click', () => {});
+        `,
+            },
+            {
+                name: 'allows removeEventListener as a local variable',
+                code: `
+          const removeEventListener = (event, handler) => {};
+          removeEventListener('click', () => {});
+        `,
+            },
+            {
+                name: 'allows location as a local variable',
+                code: `
+          const location = { pathname: '/test' };
+          console.log(location.pathname);
+        `,
+            },
+            {
+                name: 'allows history as a local variable',
+                code: `
+          const history = { push: () => {} };
+          history.push('/new-path');
+        `,
+            },
+            {
+                name: 'allows location as a function parameter',
+                code: `
+          function navigate(location) {
+            return location.href;
+          }
+        `,
+            },
+            {
+                name: 'allows history as a destructured property',
+                code: `
+          const { history } = router;
+          history.push('/test');
+        `,
+            },
+            {
+                name: 'allows location as an object property',
+                code: `
+          const obj = { location: { href: '/test' } };
+          obj.location.href;
+        `,
+            },
+            {
+                name: 'allows addEventListener as an object method',
+                code: `
+          const emitter = {
+            addEventListener(event, handler) {}
+          };
+          emitter.addEventListener('event', () => {});
+        `,
+            },
+            {
+                name: 'allows property access on objects named after restricted globals',
+                code: `
+          const myObject = { location: {}, history: {} };
+          myObject.location.href;
+          myObject.history.push('/test');
+        `,
+            },
+            {
+                name: 'allows React component event props',
+                code: `
+          import { Button } from '@hubspot/ui-extensions';
+          function Component() {
+            return <Button onClick={() => {}}>Click</Button>;
+          }
+        `,
+            },
+            {
+                name: 'allows using context for location',
+                code: `
+          function Component({ context }) {
+            const currentPath = context.location.pathname;
+            return null;
+          }
+        `,
+            },
+            {
+                name: 'allows using actions for navigation',
+                code: `
+          function Component({ actions }) {
+            actions.openLink('/new-page');
+            return null;
+          }
+        `,
+            },
+        ],
+        invalid: [
+            {
+                name: 'reports error for importScripts call',
+                code: `
+          importScripts('script.js');
+        `,
+                errors: [{ messageId: 'importScripts' }],
+            },
+            {
+                name: 'reports error for addEventListener call',
+                code: `
+          addEventListener('click', () => {});
+        `,
+                errors: [{ messageId: 'addEventListener' }],
+            },
+            {
+                name: 'reports error for removeEventListener call',
+                code: `
+          removeEventListener('click', handler);
+        `,
+                errors: [{ messageId: 'removeEventListener' }],
+            },
+            {
+                name: 'reports error for location access',
+                code: `
+          const path = location.pathname;
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error for location.href',
+                code: `
+          console.log(location.href);
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error for history access',
+                code: `
+          history.pushState({}, '', '/new-path');
+        `,
+                errors: [{ messageId: 'history' }],
+            },
+            {
+                name: 'reports error for history.back()',
+                code: `
+          history.back();
+        `,
+                errors: [{ messageId: 'history' }],
+            },
+            {
+                name: 'reports error for window.importScripts',
+                code: `
+          window.importScripts('script.js');
+        `,
+                errors: [{ messageId: 'importScripts' }],
+            },
+            {
+                name: 'reports error for window.addEventListener',
+                code: `
+          window.addEventListener('load', () => {});
+        `,
+                errors: [{ messageId: 'addEventListener' }],
+            },
+            {
+                name: 'reports error for window.removeEventListener',
+                code: `
+          window.removeEventListener('load', handler);
+        `,
+                errors: [{ messageId: 'removeEventListener' }],
+            },
+            {
+                name: 'reports error for window.location',
+                code: `
+          const url = window.location.href;
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error for window.history',
+                code: `
+          window.history.pushState({}, '', '/path');
+        `,
+                errors: [{ messageId: 'history' }],
+            },
+            {
+                name: 'reports error for self.importScripts',
+                code: `
+          self.importScripts('worker-script.js');
+        `,
+                errors: [{ messageId: 'importScripts' }],
+            },
+            {
+                name: 'reports error for self.addEventListener',
+                code: `
+          self.addEventListener('message', (e) => {});
+        `,
+                errors: [{ messageId: 'addEventListener' }],
+            },
+            {
+                name: 'reports error for self.location',
+                code: `
+          console.log(self.location.href);
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error for globalThis.importScripts',
+                code: `
+          globalThis.importScripts('script.js');
+        `,
+                errors: [{ messageId: 'importScripts' }],
+            },
+            {
+                name: 'reports error for globalThis.addEventListener',
+                code: `
+          globalThis.addEventListener('click', () => {});
+        `,
+                errors: [{ messageId: 'addEventListener' }],
+            },
+            {
+                name: 'reports error for globalThis.location',
+                code: `
+          const href = globalThis.location.href;
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error for globalThis.history',
+                code: `
+          globalThis.history.back();
+        `,
+                errors: [{ messageId: 'history' }],
+            },
+            {
+                name: 'reports error for bracket notation window["location"]',
+                code: `
+          const path = window['location'].pathname;
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error for bracket notation self["addEventListener"]',
+                code: `
+          self['addEventListener']('message', handler);
+        `,
+                errors: [{ messageId: 'addEventListener' }],
+            },
+            {
+                name: 'reports error for bracket notation globalThis["location"]',
+                code: `
+          const path = globalThis['location'].pathname;
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error in React component',
+                code: `
+          import { Text } from '@hubspot/ui-extensions';
+          function Component() {
+            const path = location.pathname;
+            return <Text>{path}</Text>;
+          }
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error in async function',
+                code: `
+          async function loadScript() {
+            importScripts('script.js');
+          }
+        `,
+                errors: [{ messageId: 'importScripts' }],
+            },
+            {
+                name: 'reports error in arrow function',
+                code: `
+          const getPath = () => location.pathname;
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error in class method',
+                code: `
+          class Navigation {
+            navigate() {
+              history.pushState({}, '', '/test');
+            }
+          }
+        `,
+                errors: [{ messageId: 'history' }],
+            },
+            {
+                name: 'reports multiple errors for different restricted globals',
+                code: `
+          const path = location.pathname;
+          history.pushState({}, '', path);
+          addEventListener('popstate', () => {});
+        `,
+                errors: [
+                    { messageId: 'location' },
+                    { messageId: 'history' },
+                    { messageId: 'addEventListener' },
+                ],
+            },
+            {
+                name: 'reports error in nested scopes',
+                code: `
+          function outer() {
+            function inner() {
+              return location.href;
+            }
+          }
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error in try/catch block',
+                code: `
+          try {
+            const path = location.pathname;
+          } catch (e) {
+            console.error(e);
+          }
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error in conditional',
+                code: `
+          if (location.pathname === '/test') {
+            console.log('test page');
+          }
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+        ],
+    });
+    tsRuleTester.run('no-restricted-globals (TypeScript)', noRestrictedGlobals, {
+        valid: [
+            {
+                name: 'allows location type in type alias',
+                code: `
+          type LocationType = typeof location;
+        `,
+            },
+            {
+                name: 'allows history type in interface property',
+                code: `
+          interface Router {
+            history: typeof history;
+          }
+        `,
+            },
+            {
+                name: 'allows addEventListener type in function return type',
+                code: `
+          function getListener(): typeof addEventListener {
+            return () => {};
+          }
+        `,
+            },
+            {
+                name: 'allows Location type references',
+                code: `
+          interface CustomLocation extends Location {
+            customProp: string;
+          }
+        `,
+            },
+        ],
+        invalid: [
+            {
+                name: 'reports error for location usage even after type declarations',
+                code: `
+          type LocationType = typeof location;
+
+          function getPath() {
+            return location.pathname;
+          }
+        `,
+                errors: [{ messageId: 'location' }],
+            },
+            {
+                name: 'reports error for history in TypeScript with explicit types',
+                code: `
+          const state: any = {};
+          history.pushState(state, '', '/test');
+        `,
+                errors: [{ messageId: 'history' }],
+            },
+            {
+                name: 'reports error for addEventListener with typed handler',
+                code: `
+          const handler: EventListener = (e) => console.log(e);
+          addEventListener('click', handler);
+        `,
+                errors: [{ messageId: 'addEventListener' }],
+            },
+        ],
+    });
+});

package/dist/__tests__/utils/ast-utils.spec.d.ts

@@ -0,0 +1 @@
+export {};