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

package/README.md

@@ -180,6 +180,7 @@ export default defineConfig([
 | [no-browser-storage](docs/rules/no-browser-storage.md)                                 | Prevent usage of browser storage APIs (localStorage and sessionStorage) in UI Extensions, which run in a sandboxed web worker environment where these APIs are not available. |    |
 | [no-console](docs/rules/no-console.md)                                                 | Prevent usage of console methods in UI Extensions in favor of the SDK logger utility.                                                                                         |    |
 | [no-dom-access](docs/rules/no-dom-access.md)                                           | Prevent access to the DOM (document object) in UI Extensions, which run in a sandboxed web worker without DOM access.                                                         |    |
+| [no-experimental-imports](docs/rules/no-experimental-imports.md)                       | Warn when importing from the experimental path of @hubspot/ui-extensions.                                                                                                     |    |
 | [no-html-elements](docs/rules/no-html-elements.md)                                     | Disallow usage of unsupported HTML elements in UI Extensions.                                                                                                                 |    |
 | [no-invalid-extension-point-imports](docs/rules/no-invalid-extension-point-imports.md) | Prevent importing components from unsupported extension points.                                                                                                               |    |
 | [no-invalid-image-src](docs/rules/no-invalid-image-src.md)                             | Only allow valid image URLs in the src attribute of Image components from @hubspot/ui-extensions.                                                                             | 🔧 |

package/dist/__tests__/index.spec.js

@@ -151,6 +151,26 @@ describe('config', () => {
             expect(customRuleError).toBeUndefined();
         });
     });
+    describe('custom no-experimental-imports rule', () => {
+        it('should warn when importing from experimental path', async () => {
+            const code = `
+        import { Grid } from '@hubspot/ui-extensions/experimental';
+      `;
+            const messages = await lintCode(code, 'src/app/cards/Component.tsx', '/path/to/project');
+            const customRuleWarning = messages.find((m) => m.ruleId === '@hubspot/ui-extensions/no-experimental-imports');
+            expect(customRuleWarning).toBeDefined();
+            expect(customRuleWarning?.severity).toBe(1);
+            expect(customRuleWarning?.message).toContain('experimental');
+        });
+        it('should allow stable @hubspot/ui-extensions imports', async () => {
+            const code = `
+        import { Text, Button } from '@hubspot/ui-extensions';
+      `;
+            const messages = await lintCode(code, 'src/app/cards/Component.tsx', '/path/to/project');
+            const customRuleWarning = messages.find((m) => m.ruleId === '@hubspot/ui-extensions/no-experimental-imports');
+            expect(customRuleWarning).toBeUndefined();
+        });
+    });
     describe('custom no-console rule', () => {
         it('should warn when using console.log()', async () => {
             const code = `

package/dist/__tests__/rules/no-experimental-imports.spec.d.ts

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

package/dist/__tests__/rules/no-experimental-imports.spec.js

@@ -0,0 +1,67 @@
+import { RuleTester } from 'eslint';
+import { noExperimentalImports } from "../../rules/no-experimental-imports.js";
+import { languageOptions } from "../../runtime.js";
+const ruleTesterOptions = {
+    languageOptions: {
+        ...languageOptions,
+        parserOptions: {
+            ecmaFeatures: {
+                jsx: true,
+            },
+        },
+    },
+};
+const experimentalImport = `
+  import { Grid } from '@hubspot/ui-extensions/experimental';
+`;
+const experimentalSubpathImport = `
+  import { getDistanceFromTshirtSize } from '@hubspot/ui-extensions/experimental/Layout/constants';
+`;
+const stableImport = `
+  import { Text, Button } from '@hubspot/ui-extensions';
+`;
+const otherPackageImport = `
+  import { useState } from 'react';
+`;
+describe('no-experimental-imports', () => {
+    const ruleTester = new RuleTester(ruleTesterOptions);
+    ruleTester.run('no-experimental-imports', noExperimentalImports, {
+        valid: [
+            {
+                name: 'stable @hubspot/ui-extensions import',
+                code: stableImport,
+                filename: '/path/to/project/src/app/cards/Component.tsx',
+            },
+            {
+                name: 'other package import',
+                code: otherPackageImport,
+                filename: '/path/to/project/src/app/cards/Component.tsx',
+            },
+            {
+                name: 'crm extension point import',
+                code: `import { useCrmProperties } from '@hubspot/ui-extensions/crm/hooks';`,
+                filename: '/path/to/project/src/app/cards/Component.tsx',
+            },
+        ],
+        invalid: [
+            {
+                name: 'import from experimental path',
+                code: experimentalImport,
+                filename: '/path/to/project/src/app/cards/Component.tsx',
+                errors: [{ messageId: 'noExperimentalImports' }],
+            },
+            {
+                name: 'import from experimental subpath',
+                code: experimentalSubpathImport,
+                filename: '/path/to/project/src/app/extensions/Component.tsx',
+                errors: [{ messageId: 'noExperimentalImports' }],
+            },
+            {
+                name: 'default import from experimental',
+                code: `import ExperimentalComponent from '@hubspot/ui-extensions/experimental';`,
+                filename: '/path/to/project/src/app/settings/Component.tsx',
+                errors: [{ messageId: 'noExperimentalImports' }],
+            },
+        ],
+    });
+});

package/dist/__tests__/utils/import-utils.spec.js

@@ -1,4 +1,4 @@
-import { getImportedComponentName, isHubspotExtensibilityImport, isRelativeImport, } from "../../utils/import-utils.js";
+import { getImportedComponentName, isExperimentalImport, isHubspotExtensibilityImport, isRelativeImport, } from "../../utils/import-utils.js";
 describe('import-utils', () => {
     describe('isHubspotExtensibilityImport', () => {
         it('should return true for @hubspot/ui-extensions imports', () => {
@@ -151,4 +151,26 @@ describe('import-utils', () => {
             expect(isRelativeImport('')).toBe(false);
         });
     });
+    describe('isExperimentalImport', () => {
+        it('should return true for @hubspot/ui-extensions/experimental', () => {
+            expect(isExperimentalImport('@hubspot/ui-extensions/experimental')).toBe(true);
+        });
+        it('should return true for experimental subpaths', () => {
+            expect(isExperimentalImport('@hubspot/ui-extensions/experimental/Layout')).toBe(true);
+            expect(isExperimentalImport('@hubspot/ui-extensions/experimental/Layout/Grid')).toBe(true);
+        });
+        it('should return false for stable @hubspot/ui-extensions imports', () => {
+            expect(isExperimentalImport('@hubspot/ui-extensions')).toBe(false);
+            expect(isExperimentalImport('@hubspot/ui-extensions/crm')).toBe(false);
+            expect(isExperimentalImport('@hubspot/ui-extensions/hooks')).toBe(false);
+        });
+        it('should return false for non-hubspot packages', () => {
+            expect(isExperimentalImport('react')).toBe(false);
+            expect(isExperimentalImport('some-package/experimental')).toBe(false);
+        });
+        it('should return false for non-string values', () => {
+            expect(isExperimentalImport(null)).toBe(false);
+            expect(isExperimentalImport(undefined)).toBe(false);
+        });
+    });
 });

package/dist/index.js

@@ -3,6 +3,7 @@ import { noBrowserDialogs } from "./rules/no-browser-dialogs.js";
 import { noBrowserStorage } from "./rules/no-browser-storage.js";
 import { noConsole } from "./rules/no-console.js";
 import { noDomAccess } from "./rules/no-dom-access.js";
+import { noExperimentalImports } from "./rules/no-experimental-imports.js";
 import { unsupportedHtmlElements } from "./rules/no-html-elements.js";
 import { noInvalidExtensionPointImports } from "./rules/no-invalid-extension-point-imports.js";
 import { noInvalidImageSrc } from "./rules/no-invalid-image-src.js";
@@ -18,6 +19,7 @@ const rules = {
     'no-browser-dialogs': noBrowserDialogs,
     'no-console': noConsole,
     'no-dom-access': noDomAccess,
+    'no-experimental-imports': noExperimentalImports,
     'no-browser-storage': noBrowserStorage,
     'no-parent-imports': noParentImports,
     'no-restricted-globals': noRestrictedGlobals,
@@ -55,6 +57,7 @@ export const config = [
             '@hubspot/ui-extensions/no-native-http': 'error',
             '@hubspot/ui-extensions/no-browser-dialogs': 'error',
             '@hubspot/ui-extensions/no-console': 'warn',
+            '@hubspot/ui-extensions/no-experimental-imports': 'warn',
             '@hubspot/ui-extensions/no-dom-access': 'error',
             '@hubspot/ui-extensions/no-browser-storage': 'error',
             '@hubspot/ui-extensions/no-parent-imports': 'error',

package/dist/rules/no-experimental-imports.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'eslint';
+export declare const noExperimentalImports: Rule.RuleModule;

package/dist/rules/no-experimental-imports.js

@@ -0,0 +1,29 @@
+import { isExperimentalImport } from "../utils/import-utils.js";
+export const noExperimentalImports = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Warn when importing from the experimental path of @hubspot/ui-extensions.',
+            url: 'https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/linting/rules/no-experimental-imports',
+        },
+        messages: {
+            noExperimentalImports: 'Imports from "{{importSource}}" use experimental APIs. Experimental components are not stable and are not recommended for production.',
+        },
+        schema: [],
+    },
+    create(context) {
+        return {
+            ImportDeclaration(node) {
+                const importSource = node.source.value;
+                if (!isExperimentalImport(importSource)) {
+                    return;
+                }
+                context.report({
+                    node,
+                    messageId: 'noExperimentalImports',
+                    data: { importSource },
+                });
+            },
+        };
+    },
+};

package/dist/runtime.js

@@ -1,6 +1,6 @@
 import globals from 'globals';
 export const languageOptions = {
-    ecmaVersion: 6,
+    ecmaVersion: 2020,
     sourceType: 'module',
     globals: {
         ...globals.worker,

package/dist/utils/import-utils.d.ts

@@ -31,3 +31,4 @@ export declare const getImportedComponentName: (node: ImportDeclaration, compone
  * @returns True if the import source is a relative import
  */
 export declare const isRelativeImport: (importSource: unknown) => importSource is string;
+export declare const isExperimentalImport: (importSource: unknown) => boolean;

package/dist/utils/import-utils.js

@@ -45,3 +45,8 @@ export const isRelativeImport = (importSource) => {
     return (typeof importSource === 'string' &&
         (importSource.startsWith('./') || importSource.startsWith('../')));
 };
+export const isExperimentalImport = (importSource) => {
+    return (typeof importSource === 'string' &&
+        isHubspotExtensibilityImport(importSource) &&
+        importSource.includes('/experimental'));
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/eslint-config-ui-extensions",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
   "description": "eslint plugins for HubSpot React-based UI Extensions",
   "keywords": [