@hs-web-team/eslint-config-node 3.2.0-next.3 → 3.2.0-next.5

package/CLAUDE.md

@@ -83,7 +83,7 @@ When testing changes to this package in downstream projects, you'll typically:
   - Documentation: `examples/stylelint-usage.md`
 
 ### Cypress Configuration
-- **`cypress.config.js`**: Shared Cypress configuration for E2E testing
+- **`cypress.config.cjs`**: Shared Cypress configuration for E2E testing
   - Uses CommonJS (`require`) syntax
   - Core settings:
     - Disables Chrome web security for cross-origin testing
@@ -111,7 +111,7 @@ When testing changes to this package in downstream projects, you'll typically:
   - Browser export (`./browser`): `browser.js` - Browser/React ESLint configuration
   - Prettier export (`./.prettierrc.json`): `.prettierrc.json` - Prettier configuration
   - Stylelint export (`./.stylelintrc.json`): `.stylelintrc.json` - Stylelint configuration
-  - Cypress export (`./cypress.config`): `cypress.config.js` - Cypress configuration
+  - Cypress export (`./cypress.config`): `cypress.config.cjs` - Cypress configuration
 - **Binary command**: `add-prettier` maps to `bin/add-prettier-scripts.js`
 
 ### Migration Context
@@ -135,7 +135,7 @@ This package is currently on v3, which uses ESLint 9's flat config format. The p
   - Cypress: Import and spread in `cypress.config.js`
 - Mixed module systems:
   - Main package is ESM (`index.js`, `browser.js`)
-  - Utility scripts use CommonJS (`bin/add-prettier-scripts.js`, `cypress.config.js`)
+  - Utility scripts use CommonJS (`bin/add-prettier-scripts.js`, `cypress.config.cjs`)
 - CI runs on Node 22 and 24 (see `.github/workflows/pr.yml`)
 - No automated tests currently (`npm test` will fail with "Error: no test specified")
 - Detailed documentation available in `examples/`:

package/cypress.config.ts

@@ -0,0 +1,120 @@
+import yaml from 'js-yaml';
+import fs from 'fs';
+import path from 'path';
+import createBundler from '@bahmutov/cypress-esbuild-preprocessor';
+import { addCucumberPreprocessorPlugin } from '@badeball/cypress-cucumber-preprocessor';
+import { createEsbuildPlugin } from '@badeball/cypress-cucumber-preprocessor/esbuild';
+
+const DEV = 'DEV';
+const QA = 'qa';
+const PROD = 'prod';
+const currentEnv = QA;
+
+export const envs = {
+  currentEnv,
+  DEV,
+  QA,
+  PROD,
+};
+
+/**
+ * @description Recursively climbs up the filepath, until it finds what directory
+ * the directory where the hubspot.config.yml file is located.
+ *
+ * @param {string} currDir - the current working directory path to search from
+ * @returns {string} The absolute path of the project's root directory
+ */
+const getRootDir = (currDir: string): string => {
+  if (fs.existsSync(path.join(currDir, 'hubspot.config.yml'))) return currDir;
+  const parentDir = path.dirname(currDir);
+  if (parentDir === currDir) {
+    throw new Error('Error: Could not find the hubspot.config.yml file within the projects directories.');
+  }
+  return getRootDir(parentDir);
+};
+
+/**
+ * @returns {string|null} The `baseUrl` set for the `DEV` portal in `hubspot.config.yml`
+ *   or `null` if this is not the dev environment or no such property exists.
+ */
+export const getDevBaseUrl = (): string | null => {
+  try {
+    global.console.log(
+      'To test a dev URL, add the `baseUrl` property to your `DEV` portal configuration in `hubspot.config.yml`',
+    );
+
+    const root = getRootDir(__dirname);
+    const configPath = path.resolve(root, 'hubspot.config.yml');
+    const fileContents = fs.readFileSync(configPath, 'utf8');
+    const { portals } = yaml.load(fileContents) as { portals: Array<{ name: string; baseUrl?: string }> };
+    const devPortal = portals.find(portal => portal.name === 'DEV');
+    return devPortal?.baseUrl || null;
+  } catch (error) {
+    global.console.error(error);
+    return null;
+  }
+};
+
+/**
+ * @description Get the baseUrls for different environments from the ci config file for local test execution.
+ * @returns {object} baseUrls - The base urls object
+ */
+export const getBaseUrls = (): Record<string, string | null> | null => {
+  let fileContents = '';
+  let ciConfig: { regression?: { e2eTestEnvironment?: Array<{ name: string; url: string }> } } = {};
+  const baseUrls: Record<string, string | null> = {};
+  baseUrls[envs.DEV] = getDevBaseUrl();
+
+  const fileExist = fs.existsSync('.ci/config.yml');
+  if (fileExist) {
+    fileContents = fs.readFileSync('.ci/config.yml', 'utf8');
+    ciConfig = yaml.load(fileContents) as typeof ciConfig;
+    if (ciConfig.regression?.e2eTestEnvironment && ciConfig.regression.e2eTestEnvironment.length > 0) {
+      try {
+        ciConfig.regression.e2eTestEnvironment.forEach(item => {
+          baseUrls[item.name] = item.url;
+        });
+      } catch (error) {
+        console.error('Error reading the base urls from the ci config file:', error);
+        return null;
+      }
+    }
+  }
+  return baseUrls || null;
+};
+
+async function setupNodeEvents(
+  on: Cypress.PluginEvents,
+  config: Cypress.PluginConfigOptions,
+): Promise<Cypress.PluginConfigOptions> {
+  await addCucumberPreprocessorPlugin(on, config);
+  on(
+    'file:preprocessor',
+    createBundler({ plugins: [createEsbuildPlugin(config)] }),
+  );
+  return config;
+}
+
+const e2e: Cypress.EndToEndConfigOptions = {
+  specPattern: 'cypress/e2e/*.cy.js',
+  setupNodeEvents,
+};
+
+export const config: Cypress.ConfigOptions = {
+  chromeWebSecurity: false,
+  defaultCommandTimeout: 20000,
+  e2e,
+  numTestsKeptInMemory: 0,
+  pageLoadTimeout: 20000,
+  port: 3500,
+  responseTimeout: 20000,
+  retries: {
+    runMode: 1,
+    openMode: 0,
+  },
+  screenshotOnRunFailure: true,
+  trashAssetsBeforeRuns: true,
+  video: false,
+  viewportHeight: 1080,
+  viewportWidth: 1920,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hs-web-team/eslint-config-node",
-  "version": "3.2.0-next.3",
+  "version": "3.2.0-next.5",
   "description": "HubSpot Marketing WebTeam shared configurations for ESLint, Prettier, Stylelint, and Cypress",
   "main": "index.js",
   "type": "module",
@@ -9,8 +9,7 @@
     "./browser": "./browser.js",
     "./.prettierrc.json": "./.prettierrc.json",
     "./.stylelintrc.json": "./.stylelintrc.json",
-    "./cypress.config.js": "./cypress.config.js",
-    "./cypress.config.ts": "./cypress.config.ts"
+    "./cypress.config": "./cypress.config.cjs"
   },
   "scripts": {
     "lint": "npx eslint -c ./index.js *.js --fix",
@@ -54,13 +53,13 @@
     "globals": "^17.3.0",
     "jiti": "^2.6.1",
     "prettier": "^3.8.1",
-    "typescript-eslint": "^8.54.0"
+    "typescript-eslint": "^8.54.0",
+    "esbuild": "^0.27.2",
+    "js-yaml": "^4.1.1"
   },
   "peerDependencies": {
     "@badeball/cypress-cucumber-preprocessor": "^24.0.0",
     "cypress": "^15.0.0",
-    "esbuild": "^0.27.2",
-    "js-yaml": "^4.1.1",
     "stylelint": "^17.1.1",
     "stylelint-config-standard": "^40.0.0",
     "stylelint-config-standard-scss": "^17.0.0"
@@ -77,15 +76,6 @@
     },
     "cypress": {
       "optional": true
-    },
-    "@badeball/cypress-cucumber-preprocessor": {
-      "optional": true
-    },
-    "esbuild": {
-      "optional": true
-    },
-    "js-yaml": {
-      "optional": true
     }
   }
 }