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

package/CLAUDE.md

@@ -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.cjs` - Cypress configuration
+  - Cypress export (`./cypress.config`): `cypress.config.cjs` (runtime), `cypress.config.d.ts` (types)
 - **Binary command**: `add-prettier` maps to `bin/add-prettier-scripts.js`
 
 ### Migration Context

package/cypress.config.cjs

@@ -127,4 +127,5 @@ module.exports = {
   envs,
   getDevBaseUrl,
   getBaseUrls,
+  setupNodeEvents,
 };

package/cypress.config.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="cypress" />
+
+export declare const envs: {
+  currentEnv: string;
+  DEV: string;
+  QA: string;
+  PROD: string;
+};
+
+export declare const config: Cypress.ConfigOptions;
+
+export declare function setupNodeEvents(
+  on: Cypress.PluginEvents,
+  config: Cypress.PluginConfigOptions
+): Promise<Cypress.PluginConfigOptions>;
+
+export declare function getDevBaseUrl(): string | null;
+export declare function getBaseUrls(): Record<string, string | null> | null;

package/examples/cypress-usage.md

@@ -221,19 +221,22 @@ module.exports = defineConfig({
 
 ### Add Custom setupNodeEvents
 
+`setupNodeEvents` is exported directly and is also embedded inside `config.e2e`. If you override it without calling the package's version first, you'll silently lose the Cucumber preprocessor and esbuild setup.
+
+Import `setupNodeEvents` directly and call it before your own logic:
+
 ```javascript
 const { defineConfig } = require('cypress');
-const { config } = require('@hs-web-team/eslint-config-node/cypress.config');
+const { config, setupNodeEvents: wtSetupNodeEvents } = require('@hs-web-team/eslint-config-node/cypress.config');
 
 module.exports = defineConfig({
   ...config,
   e2e: {
     ...config.e2e,
-    async setupNodeEvents(on, cypressConfig) {
-      // Call shared setup first (includes esbuild preprocessor and Cucumber setup)
-      const updatedConfig = await config.e2e.setupNodeEvents(on, cypressConfig);
+    async setupNodeEvents(on, cfg) {
+      // sets up esbuild preprocessor and Cucumber
+      await wtSetupNodeEvents(on, cfg);
 
-      // Add your custom tasks/events
       on('task', {
         log(message) {
           console.log(message);
@@ -241,12 +244,14 @@ module.exports = defineConfig({
         },
       });
 
-      return updatedConfig;
+      return cfg;
     },
   },
 });
 ```
 
+If you don't need custom node events, omit `setupNodeEvents` entirely and just spread `...config.e2e` — the package's setup runs automatically.
+
 ## Integration with CI/CD
 
 ### GitHub Actions Example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hs-web-team/eslint-config-node",
-  "version": "3.2.0-next.5",
+  "version": "3.2.0-next.6",
   "description": "HubSpot Marketing WebTeam shared configurations for ESLint, Prettier, Stylelint, and Cypress",
   "main": "index.js",
   "type": "module",
@@ -9,7 +9,17 @@
     "./browser": "./browser.js",
     "./.prettierrc.json": "./.prettierrc.json",
     "./.stylelintrc.json": "./.stylelintrc.json",
-    "./cypress.config": "./cypress.config.cjs"
+    "./cypress.config": {
+      "types": "./cypress.config.d.ts",
+      "require": "./cypress.config.cjs"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "cypress.config": [
+        "./cypress.config.d.ts"
+      ]
+    }
   },
   "scripts": {
     "lint": "npx eslint -c ./index.js *.js --fix",