feat: log process pid only when CODSPEED_DEBUG is set

Author: adriencaccia

packages/benchmark.js-plugin/benches/sample.ts

@@ -1,3 +1,4 @@
+import { logDebug } from "@codspeed/core";
 import Benchmark from "benchmark";
 import { withCodSpeed } from "..";
 import parsePr from "./parsePr";
@@ -11,7 +12,7 @@ const LONG_BODY =
 
 const suite = withCodSpeed(new Benchmark.Suite());
 
-console.log(`PROCESS PID: ${process.pid} in ${__filename}`);
+logDebug(`PROCESS PID: ${process.pid} in ${__filename}`);
 
 suite
   .add("RegExp#test", function () {

packages/core/src/utils.ts

@@ -8,3 +8,12 @@ export function getGitDir(path: string): string | undefined {
   } as FindupOptions);
   return dotGitPath ? dirname(dotGitPath) : undefined;
 }
+
+/**
+ * Log debug messages if the environment variable `CODSPEED_DEBUG` is set.
+ */
+export function logDebug(...args: unknown[]) {
+  if (process.env.CODSPEED_DEBUG) {
+    console.log(...args);
+  }
+}

packages/tinybench-plugin/benches/sample.ts

@@ -1,3 +1,4 @@
+import { logDebug } from "@codspeed/core";
 import { Bench } from "tinybench";
 import { withCodSpeed } from "..";
 import parsePr from "./parsePr";
@@ -11,7 +12,7 @@ const LONG_BODY =
 
 const bench = withCodSpeed(new Bench({ time: 100 }));
 
-console.log(`PROCESS PID: ${process.pid} in ${__filename}`);
+logDebug(`PROCESS PID: ${process.pid} in ${__filename}`);
 
 bench
   .add("switch 1", () => {

packages/vitest-plugin/src/runner.ts

@@ -1,5 +1,6 @@
 import {
   getGitDir,
+  logDebug,
   Measurement,
   optimizeFunction,
   setupCore,
@@ -66,7 +67,7 @@ function patchRootSuiteWithFullFilePath(suite: Suite) {
 
 class CodSpeedRunner extends NodeBenchmarkRunner {
   async runSuite(suite: Suite): Promise<void> {
-    logCodSpeed(`PROCESS PID: ${process.pid} in ${__filename}`);
+    logDebug(`PROCESS PID: ${process.pid} in ${__filename}`);
     setupCore();
 
     patchRootSuiteWithFullFilePath(suite);