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

package/dist/__tests__/rules/no-browser-dialogs.spec.js

@@ -0,0 +1,263 @@
+import { RuleTester } from 'eslint';
+import tseslint from 'typescript-eslint';
+import { noBrowserDialogs } from "../../rules/no-browser-dialogs.js";
+import { languageOptions } from "../../runtime.js";
+const ruleTester = new RuleTester({
+    languageOptions: {
+        ...languageOptions,
+        parserOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            ecmaFeatures: {
+                jsx: true,
+            },
+        },
+    },
+});
+// Separate tester for TypeScript code
+const tsRuleTester = new RuleTester({
+    languageOptions: {
+        ...languageOptions,
+        parser: tseslint.parser,
+        parserOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+        },
+    },
+});
+describe('no-browser-dialogs', () => {
+    // Main test suite with JavaScript code
+    ruleTester.run('no-browser-dialogs', noBrowserDialogs, {
+        valid: [
+            {
+                name: 'allows dialog methods on other objects',
+                code: `
+          const custom = { alert: () => {}, confirm: () => {}, prompt: () => {} };
+          custom.alert('msg');
+          custom.confirm('msg');
+          custom.prompt('msg');
+        `,
+            },
+            {
+                name: 'allows dialog methods as function parameters',
+                code: `
+          function process(alert, confirm, prompt) {
+            alert('msg');
+            confirm('msg');
+            prompt('msg');
+          }
+        `,
+            },
+            {
+                name: 'allows locally declared dialog functions',
+                code: `
+          const alert = (msg) => actions.addAlert(msg);
+          const confirm = (msg) => showModal(msg);
+          const prompt = (msg) => showInputModal(msg);
+          alert('msg');
+          confirm('msg');
+          prompt('msg');
+        `,
+            },
+            {
+                name: 'allows destructured dialog methods from objects',
+                code: `
+          const { alert, confirm, prompt } = customDialogs;
+          alert('msg');
+          confirm('msg');
+          prompt('msg');
+        `,
+            },
+            {
+                name: 'ignores dialog methods in comments and strings',
+                code: `
+          // Use alert() to show messages
+          const msg = 'Use confirm() for decisions';
+          /* prompt() gets user input */
+          actions.addAlert('Hello');
+        `,
+            },
+        ],
+        invalid: [
+            {
+                name: 'reports errors for global calls to dialog APIs',
+                code: `
+          alert('Attention');
+          confirm('Are you sure?');
+          prompt('Enter your name:');
+        `,
+                errors: [
+                    {
+                        messageId: 'nativeAlert',
+                    },
+                    {
+                        messageId: 'nativeConfirm',
+                    },
+                    {
+                        messageId: 'nativePrompt',
+                    },
+                ],
+            },
+            {
+                name: 'reports errors for window calls to dialog APIs',
+                code: `
+          window.alert('Attention');
+          window['confirm']('Are you sure?');
+          window.prompt('Enter your name:');
+
+        `,
+                errors: [
+                    {
+                        messageId: 'nativeAlert',
+                    },
+                    {
+                        messageId: 'nativeConfirm',
+                    },
+                    {
+                        messageId: 'nativePrompt',
+                    },
+                ],
+            },
+            {
+                name: 'reports errors for globalThis calls to dialog APIs',
+                code: `
+          globalThis['alert']('Attention');
+          globalThis.confirm('Are you sure?');
+          globalThis['prompt']('Enter your name:');
+        `,
+                errors: [
+                    {
+                        messageId: 'nativeAlert',
+                    },
+                    {
+                        messageId: 'nativeConfirm',
+                    },
+                    {
+                        messageId: 'nativePrompt',
+                    },
+                ],
+            },
+            {
+                name: 'reports errors for self calls to dialog APIs',
+                code: `
+          self.alert('Attention');
+          self['confirm']('Are you sure?');
+          self.prompt('Enter your name:');
+        `,
+                errors: [
+                    {
+                        messageId: 'nativeAlert',
+                    },
+                    {
+                        messageId: 'nativeConfirm',
+                    },
+                    {
+                        messageId: 'nativePrompt',
+                    },
+                ],
+            },
+            {
+                name: 'reports error in React component with JSX',
+                code: `
+          import { Text } from '@hubspot/ui-extensions';
+          function Component() {
+            alert('Error');
+            return <Text>Hello</Text>;
+          }
+        `,
+                errors: [{ messageId: 'nativeAlert' }],
+            },
+            {
+                name: 'reports error in async, arrow, and class method contexts',
+                code: `
+          async function test1() { alert('async'); }
+          const test2 = () => confirm('arrow');
+          class Test { method() { prompt('class'); } }
+        `,
+                errors: [
+                    { messageId: 'nativeAlert' },
+                    { messageId: 'nativeConfirm' },
+                    { messageId: 'nativePrompt' },
+                ],
+            },
+            {
+                name: 'reports error in try/catch and nested scopes',
+                code: `
+          try { alert('error'); } catch (e) { confirm('caught'); }
+          function outer() { function inner() { prompt('nested'); } }
+        `,
+                errors: [
+                    { messageId: 'nativeAlert' },
+                    { messageId: 'nativeConfirm' },
+                    { messageId: 'nativePrompt' },
+                ],
+            },
+        ],
+    });
+    // TypeScript-specific tests (requires TypeScript parser)
+    tsRuleTester.run('no-browser-dialogs (TypeScript)', noBrowserDialogs, {
+        valid: [
+            {
+                name: 'allows dialog types in type alias',
+                code: `
+          type AlertType = typeof alert;
+          type ConfirmType = typeof confirm;
+          type PromptType = typeof prompt;
+        `,
+            },
+            {
+                name: 'allows dialog types in interface property',
+                code: `
+          interface TestClient {
+            alert: typeof alert;
+            confirm: typeof confirm;
+            prompt: typeof prompt;
+          }
+        `,
+            },
+            {
+                name: 'allows dialog types in function return type',
+                code: `
+          function getRequestFn(): typeof alert {
+            return action.addAlert;
+          }
+
+          function getConfirmFn(): typeof confirm {
+            return action.addConfirm;
+          }
+
+          function getPromptFn(): typeof prompt {
+            return action.addPrompt;
+          }
+        `,
+            },
+        ],
+        invalid: [
+            {
+                name: 'reports error for dialog calls even after type declarations',
+                code: `
+          type AlertType = typeof alert;
+          type ConfirmType = typeof confirm;
+          type PromptType = typeof prompt;
+
+          function getData() {
+            alert('Attention');
+            confirm('Are you sure?');
+            prompt('Enter your name:');
+          }
+        `,
+                errors: [
+                    {
+                        messageId: 'nativeAlert',
+                    },
+                    {
+                        messageId: 'nativeConfirm',
+                    },
+                    {
+                        messageId: 'nativePrompt',
+                    },
+                ],
+            },
+        ],
+    });
+});

package/dist/__tests__/rules/no-browser-storage.spec.d.ts

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

package/dist/__tests__/rules/no-browser-storage.spec.js

@@ -0,0 +1,428 @@
+import { RuleTester } from 'eslint';
+import tseslint from 'typescript-eslint';
+import { noBrowserStorage } from "../../rules/no-browser-storage.js";
+import { languageOptions } from "../../runtime.js";
+const ruleTester = new RuleTester({
+    languageOptions: {
+        ...languageOptions,
+        parserOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+            ecmaFeatures: {
+                jsx: true,
+            },
+        },
+    },
+});
+// Separate tester for TypeScript code
+const tsRuleTester = new RuleTester({
+    languageOptions: {
+        ...languageOptions,
+        parser: tseslint.parser,
+        parserOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+        },
+    },
+});
+describe('no-browser-storage', () => {
+    // Main test suite with JavaScript code
+    ruleTester.run('no-browser-storage', noBrowserStorage, {
+        valid: [
+            {
+                name: 'allows localStorage as a local variable',
+                code: `
+          const localStorage = { getItem: () => null };
+          localStorage.getItem('key');
+        `,
+            },
+            {
+                name: 'allows sessionStorage as a local variable',
+                code: `
+          const sessionStorage = { setItem: () => {} };
+          sessionStorage.setItem('key', 'value');
+        `,
+            },
+            {
+                name: 'allows localStorage as a function parameter',
+                code: `
+          function save(localStorage) {
+            return localStorage.getItem('data');
+          }
+        `,
+            },
+            {
+                name: 'allows sessionStorage as a function parameter',
+                code: `
+          function load(sessionStorage) {
+            return sessionStorage.getItem('data');
+          }
+        `,
+            },
+            {
+                name: 'allows localStorage as a destructured property',
+                code: `
+          const { localStorage } = customStorage;
+          localStorage.getItem('key');
+        `,
+            },
+            {
+                name: 'allows sessionStorage as a destructured property',
+                code: `
+          const { sessionStorage } = customStorage;
+          sessionStorage.setItem('key', 'value');
+        `,
+            },
+            {
+                name: 'allows localStorage property on other objects',
+                code: `
+          const storage = { localStorage: {} };
+          storage.localStorage.getItem('key');
+        `,
+            },
+            {
+                name: 'allows sessionStorage property on other objects',
+                code: `
+          const storage = { sessionStorage: {} };
+          storage.sessionStorage.setItem('key', 'value');
+        `,
+            },
+            {
+                name: 'allows string "localStorage" and "sessionStorage" in strings, comments, etc.',
+                code: `
+          const key = 'localStorage.data';
+          // Check sessionStorage for changes
+        `,
+            },
+        ],
+        invalid: [
+            {
+                name: 'reports error for localStorage method calls',
+                code: `
+          localStorage.getItem('key');
+          localStorage.setItem('key', 'value');
+          localStorage.removeItem('key');
+          localStorage.clear();
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for sessionStorage method calls',
+                code: `
+          sessionStorage.getItem('key');
+          sessionStorage.setItem('key', 'value');
+          sessionStorage.removeItem('key');
+          sessionStorage.clear();
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for localStorage property access',
+                code: `
+          const length = localStorage.length;
+          const key = localStorage.key(0);
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for sessionStorage property access',
+                code: `
+          const length = sessionStorage.length;
+          const key = sessionStorage.key(0);
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for localStorage reference assignment',
+                code: `
+          const storage = localStorage;
+          storage.setItem('key', 'value');
+        `,
+                errors: [
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                ],
+            },
+            {
+                name: 'reports error for sessionStorage reference assignment',
+                code: `
+          const storage = sessionStorage;
+          storage.getItem('key');
+        `,
+                errors: [
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                ],
+            },
+            {
+                name: 'reports error for window.localStorage access',
+                code: `
+          window.localStorage.setItem('key', 'value');
+          window.localStorage.getItem('key');
+          window['localStorage'].clear();
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for window.sessionStorage access',
+                code: `
+          window.sessionStorage.setItem('key', 'value');
+          window.sessionStorage.getItem('key');
+          window['sessionStorage'].clear();
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for globalThis.localStorage access',
+                code: `
+          globalThis.localStorage.setItem('key', 'value');
+          globalThis['localStorage'].getItem('key');
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for globalThis.sessionStorage access',
+                code: `
+          globalThis.sessionStorage.setItem('key', 'value');
+          globalThis['sessionStorage'].getItem('key');
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for self.localStorage access',
+                code: `
+          self.localStorage.setItem('key', 'value');
+          self['localStorage'].getItem('key');
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for self.sessionStorage access',
+                code: `
+          self.sessionStorage.setItem('key', 'value');
+          self['sessionStorage'].getItem('key');
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error in React component with JSX',
+                code: `
+          import { Text } from '@hubspot/ui-extensions';
+          function Component() {
+            const data = localStorage.getItem('key');
+            return <Text>Hello</Text>;
+          }
+        `,
+                errors: [{ messageId: 'noBrowserStorage' }],
+            },
+            {
+                name: 'reports error in async, arrow, and class method contexts',
+                code: `
+          async function test1() { localStorage.getItem('key'); }
+          const test2 = () => sessionStorage.setItem('key', 'value');
+          class Test { method() { return localStorage.length; } }
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error in try/catch and nested scopes',
+                code: `
+          try {
+            localStorage.setItem('key', 'value');
+          } catch (e) {
+            console.log(e);
+          }
+          function outer() {
+            function inner() {
+              return sessionStorage.getItem('key');
+            }
+          }
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+            {
+                name: 'reports error for chained property access',
+                code: `
+          const firstKey = localStorage.key(0);
+          const value = sessionStorage.getItem(firstKey);
+        `,
+                errors: [
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                ],
+            },
+            {
+                name: 'reports error for storage in conditional',
+                code: `
+          if (localStorage.length > 0) {
+            sessionStorage.clear();
+          }
+        `,
+                errors: [
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                ],
+            },
+            {
+                name: 'reports errors for mixed localStorage and sessionStorage usage',
+                code: `
+          const data = localStorage.getItem('key');
+          sessionStorage.setItem('other', data);
+          window.localStorage.clear();
+          self.sessionStorage.clear();
+        `,
+                errors: [
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                    { messageId: 'noBrowserStorage' },
+                ],
+            },
+        ],
+    });
+    // TypeScript-specific tests (requires TypeScript parser)
+    tsRuleTester.run('no-browser-storage (TypeScript)', noBrowserStorage, {
+        valid: [
+            {
+                name: 'allows localStorage type in type alias',
+                code: `
+          type LocalStorageType = typeof localStorage;
+        `,
+            },
+            {
+                name: 'allows sessionStorage type in type alias',
+                code: `
+          type SessionStorageType = typeof sessionStorage;
+        `,
+            },
+            {
+                name: 'allows storage types in interface property',
+                code: `
+          interface StorageManager {
+            local: typeof localStorage;
+            session: typeof sessionStorage;
+          }
+        `,
+            },
+            {
+                name: 'allows storage types in function return type',
+                code: `
+          function getLocalStorage(): typeof localStorage {
+            return {} as any;
+          }
+          function getSessionStorage(): typeof sessionStorage {
+            return {} as any;
+          }
+        `,
+            },
+            {
+                name: 'allows Storage type references',
+                code: `
+          interface CustomStorage extends Storage {
+            customMethod(): void;
+          }
+        `,
+            },
+        ],
+        invalid: [
+            {
+                name: 'reports error for localStorage usage even after type declarations',
+                code: `
+          type LocalStorageType = typeof localStorage;
+
+          function getData() {
+            const data = localStorage.getItem('key');
+          }
+        `,
+                errors: [
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                ],
+            },
+            {
+                name: 'reports error for sessionStorage usage even after type declarations',
+                code: `
+          type SessionStorageType = typeof sessionStorage;
+
+          function setData() {
+            sessionStorage.setItem('key', 'value');
+          }
+        `,
+                errors: [
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                ],
+            },
+            {
+                name: 'reports error for storage in TypeScript with explicit types',
+                code: `
+          const data: string | null = localStorage.getItem('key');
+          const length: number = sessionStorage.length;
+        `,
+                errors: [
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                    {
+                        messageId: 'noBrowserStorage',
+                    },
+                ],
+            },
+        ],
+    });
+});

package/dist/__tests__/rules/no-console.spec.d.ts

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