fix: remove console messages in production

Author: CreativeTechGuy

src/getVisitedPathData/getVisitedPathData.ts

@@ -1,5 +1,6 @@
 import { isRecursiveProxyMock } from "~/isRecursiveProxyMock";
 import type { ProxyData, ProxyPath, ProxyStackItem } from "~/proxyTypes";
+import { developmentLog } from "~/utils/developmentLog";
 import { doPathsMatch } from "~/utils/doPathsMatch";
 import { getCurrentPath } from "~/utils/getCurrentPath";
 import { getProxyStack } from "~/utils/getProxyStack";
@@ -11,7 +12,7 @@ import { getProxyStack } from "~/utils/getProxyStack";
  */
 export function getVisitedPathData(proxy: unknown, path: ProxyPath): ProxyData[] | null {
     if (!isRecursiveProxyMock(proxy)) {
-        console.warn("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
+        developmentLog("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
         return null;
     }
     const proxyStack = getProxyStack(proxy);

src/hasPathBeenCalledWith/hasPathBeenCalledWith.ts

@@ -2,6 +2,7 @@ import { getVisitedPathData } from "~/getVisitedPathData";
 import { isRecursiveProxyMock } from "~/isRecursiveProxyMock";
 import { ProxySymbol } from "~/ProxySymbol";
 import type { ProxyCallableItem, ProxyPath } from "~/proxyTypes";
+import { developmentLog } from "~/utils/developmentLog";
 import { doArraysMatch } from "~/utils/doArraysMatch";
 
 /**
@@ -12,11 +13,11 @@ import { doArraysMatch } from "~/utils/doArraysMatch";
  */
 export function hasPathBeenCalledWith(proxy: unknown, path: ProxyPath, args: unknown[]): boolean {
     if (!isRecursiveProxyMock(proxy)) {
-        console.warn("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
+        developmentLog("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
         return false;
     }
     if (![ProxySymbol.APPLY, ProxySymbol.CONSTRUCT].includes(path[path.length - 1] as symbol)) {
-        console.warn("The path must end with `ProxySymbol.APPLY` or `ProxySymbol.CONSTRUCT`");
+        developmentLog("The path must end with `ProxySymbol.APPLY` or `ProxySymbol.CONSTRUCT`");
         return false;
     }
     const visitedPathData = (getVisitedPathData(proxy, path) ?? []) as ProxyCallableItem[];

src/hasPathBeenVisited/hasPathBeenVisited.ts

@@ -2,6 +2,7 @@ import { isRecursiveProxyMock } from "~/isRecursiveProxyMock";
 import type { ProxyPath } from "~/proxyTypes";
 // eslint-disable-next-line @typescript-eslint/no-unused-vars -- used in JSDoc
 import { recursiveProxyMock } from "~/recursiveProxyMock";
+import { developmentLog } from "~/utils/developmentLog";
 import { doPathsMatch } from "~/utils/doPathsMatch";
 import { listAllPaths } from "~/utils/listAllPaths";
 
@@ -12,7 +13,7 @@ import { listAllPaths } from "~/utils/listAllPaths";
  */
 export function hasPathBeenVisited(proxy: unknown, path: ProxyPath): boolean {
     if (!isRecursiveProxyMock(proxy)) {
-        console.warn("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
+        developmentLog("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
         return false;
     }
     const allPaths = listAllPaths(proxy);

src/listAllProxyOperations/listAllProxyOperations.ts

@@ -1,5 +1,6 @@
 import { isRecursiveProxyMock } from "~/isRecursiveProxyMock";
 import type { ProxyData } from "~/proxyTypes";
+import { developmentLog } from "~/utils/developmentLog";
 import { getProxyStack } from "~/utils/getProxyStack";
 
 /**
@@ -8,7 +9,7 @@ import { getProxyStack } from "~/utils/getProxyStack";
  */
 export function listAllProxyOperations(proxy: unknown): ProxyData[] {
     if (!isRecursiveProxyMock(proxy)) {
-        console.warn("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
+        developmentLog("Must pass an object created with `recursiveProxyMock()`. Instead received:", proxy);
         return [];
     }
     return getProxyStack(proxy);

src/utils/developmentLog/developmentLog.test.ts

@@ -0,0 +1,19 @@
+import { developmentLog } from "~/utils/developmentLog";
+
+describe("developmentLog", () => {
+    beforeEach(() => {
+        process.env.NODE_ENV = "test";
+    });
+    test("uses console.warn in non-production mode", () => {
+        const consoleWarnSpy = jest.spyOn(console, "warn").mockImplementation();
+        developmentLog("message", 123);
+        expect(consoleWarnSpy).toHaveBeenCalledWith("message", 123);
+    });
+
+    test("does not log in production", () => {
+        process.env.NODE_ENV = "production";
+        const consoleWarnSpy = jest.spyOn(console, "warn").mockImplementation();
+        developmentLog("message", 123);
+        expect(consoleWarnSpy).not.toHaveBeenCalled();
+    });
+});

src/utils/developmentLog/developmentLog.ts

@@ -0,0 +1,5 @@
+export function developmentLog(...messages: unknown[]): void {
+    if (process.env.NODE_ENV !== "production") {
+        console.warn(...messages);
+    }
+}

src/utils/developmentLog/index.ts

@@ -0,0 +1 @@
+export { developmentLog } from "./developmentLog";