feat(Cypress-SignalR-Mock): Added support for using Cypress-SignalR-M…

…ock with Vitest unit testing in the same way as using it for Cypress

src/index.ts

@@ -7,27 +7,38 @@ import HubConnectionMock from "./types/HubConnectionMock";
 import { setupCypressCommands } from "./cypress-commands";
 import IMockData from "./types/IMockData";
 import IServerInvoke from "./types/IServerInvoke";
-import { getCypressSignalrMockData, isCypressRunning } from "./utils.ts";
+import {
+  getCypressSignalrMockData,
+  isCypressRunning,
+  isInVitestMode,
+} from "./utils.ts";
 import Log from "./log.ts";
 
 setupCypressCommands();
 useCypressSignalRMock("default");
 
 export function useCypressSignalRMock(
   name: string,
-  { debug }: Partial<{ debug?: boolean }> = {}
+  {
+    debug,
+    enableForVitest,
+  }: Partial<{ debug?: boolean; enableForVitest?: boolean }> = {}
 ): HubConnection | null {
-  if (!isCypressRunning()) {
-    return null;
-  }
-
   if (debug) {
     Log.setLogLevel(4);
   }
+  if (!enableForVitest && isInVitestMode()) {
+    Log.info(
+      `Vitest is running but 'enableForVitest' is ${enableForVitest}, skip enabling CypressSignalRMock...`
+    );
+  }
 
-  const mock = new HubConnectionMock(name);
-  getCypressSignalrMockData().mocks.push(mock);
-  return <HubConnection>(mock as unknown);
+  if (isCypressRunning() || (enableForVitest && isInVitestMode())) {
+    const mock = new HubConnectionMock(name);
+    getCypressSignalrMockData().mocks.push(mock);
+    return <HubConnection>(mock as unknown);
+  }
+  return null;
 }
 
 /**
@@ -77,3 +88,10 @@ declare global {
     }
   }
 }
+
+export {
+  hubPublish,
+  hubVerify,
+  hubClear,
+  hubPrintData,
+} from "./cypress-commands";

src/utils.ts

@@ -52,3 +52,11 @@ export function isSSR(): boolean {
   }
   return false;
 }
+
+export function isInVitestMode(): boolean {
+  return (
+    typeof process !== "undefined" &&
+    process?.env?.hasOwnProperty("VITEST") &&
+    process.env.VITEST === "true"
+  );
+}