dceky 1.2.0 → 1.2.1-beta-setup-node-events.1

package/README.md

@@ -137,3 +137,13 @@ const myReturnValue = { hello: 'world' };
 
 return ky.wrap(myReturnValue);
 ```
+
+### Adding a Custom Setup Node Events Script
+
+If you want to add a custom `setupNodeEvents` script, create a `/cypress/support/setupNodeEvents.ts` module that exports a single default function of the following type:
+
+```ts
+((on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions) => Cypress.PluginConfigOptions | void)
+```
+
+Ky will automatically look for this file and add it to the configuration if it exists, so there's no need to import it or add it to the config manually. This is useful for adding custom functionality that happens _outside the browser_.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dceky",
-  "version": "1.2.0",
+  "version": "1.2.1-beta-setup-node-events.1",
   "description": "Cypress toolkit for Harvard DCE",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",

package/src/genConfiguration/index.ts

@@ -2,6 +2,7 @@
 /* eslint-disable global-require */
 /* eslint-disable import/no-dynamic-require */
 import path from 'path';
+import fs from 'fs';
 
 // Import cypress
 import { defineConfig } from 'cypress';
@@ -111,11 +112,23 @@ const genConfiguration = () => {
     baseUrl = `https://${baseUrl}`;
   }
 
+  // Look for a /cypress/support/setupNodeEvents.ts file and add it to the config if it exists
+  const setupNodeEventsPath = path.join(CWD, '/cypress/support/setupNodeEvents.ts');
+  const setupNodeEventsExists = fs.existsSync(setupNodeEventsPath);
+  let setupNodeEvents: (
+    ((on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions) => Cypress.PluginConfigOptions | void)
+    | undefined
+  );
+  if (setupNodeEventsExists) {
+    setupNodeEvents = require(setupNodeEventsPath).default;
+  }
+
   // Return the configuration object
   return defineConfig({
     e2e: {
       experimentalWebKitSupport: true,
       experimentalOriginDependencies: true,
+      setupNodeEvents,
       baseUrl,
       expose: exposed,
       env: securedEnv,