feat(utils): parse boolean environment variables

Author: matejchalk

packages/utils/src/index.ts

@@ -9,6 +9,7 @@ export {
 export { filesCoverageToTree, type FileCoverage } from './lib/coverage-tree.js';
 export { createRunnerFiles } from './lib/create-runner-files.js';
 export { comparePairs, matchArrayItemsByKey, type Diff } from './lib/diff.js';
+export { isEnvVarEnabled, isVerbose } from './lib/env.js';
 export { stringifyError } from './lib/errors.js';
 export {
   executeProcess,
@@ -69,7 +70,7 @@ export {
   isPromiseRejectedResult,
 } from './lib/guards.js';
 export { logMultipleResults } from './lib/log-results.js';
-export { isVerbose, link, ui, type CliUi, type Column } from './lib/logging.js';
+export { link, ui, type CliUi, type Column } from './lib/logging.js';
 export { mergeConfigs } from './lib/merge-configs.js';
 export { getProgressBar, type ProgressBar } from './lib/progress.js';
 export { asyncSequential, groupByStatus } from './lib/promises.js';

packages/utils/src/lib/env.ts

@@ -0,0 +1,28 @@
+import { ui } from './logging.js';
+
+export function isVerbose() {
+  return isEnvVarEnabled('CP_VERBOSE');
+}
+
+export function isEnvVarEnabled(name: string): boolean {
+  const value = process.env[name];
+
+  if (!value) {
+    return false;
+  }
+
+  if (value.toLowerCase() === 'true') {
+    return true;
+  }
+
+  const int = Number.parseInt(value, 10);
+  if (!Number.isNaN(int) && int !== 0) {
+    return true;
+  }
+
+  ui().logger.warning(
+    `Environment variable ${name} expected to be a boolean (true/false/1/0), but received value ${value}. Treating it as disabled.`,
+  );
+
+  return false;
+}

packages/utils/src/lib/env.unit.test.ts

@@ -0,0 +1,41 @@
+import { isEnvVarEnabled } from './env.js';
+import { ui } from './logging.js';
+
+describe('isEnvVarEnabled', () => {
+  beforeEach(() => {
+    vi.unstubAllEnvs();
+  });
+
+  it('should consider missing variable disabled', () => {
+    expect(isEnvVarEnabled('CP_VERBOSE')).toBe(false);
+  });
+
+  it('should consider "true" enabled', () => {
+    vi.stubEnv('CP_VERBOSE', 'true');
+    expect(isEnvVarEnabled('CP_VERBOSE')).toBe(true);
+  });
+
+  it('should consider "false" disabled', () => {
+    vi.stubEnv('CP_VERBOSE', 'false');
+    expect(isEnvVarEnabled('CP_VERBOSE')).toBe(false);
+  });
+
+  it('should consider "1" enabled', () => {
+    vi.stubEnv('CP_VERBOSE', '1');
+    expect(isEnvVarEnabled('CP_VERBOSE')).toBe(true);
+  });
+
+  it('should consider "0" disabled', () => {
+    vi.stubEnv('CP_VERBOSE', '0');
+    expect(isEnvVarEnabled('CP_VERBOSE')).toBe(false);
+  });
+
+  it('should log a warning for unexpected values', () => {
+    vi.stubEnv('CP_VERBOSE', 'unexpected');
+    expect(isEnvVarEnabled('CP_VERBOSE')).toBe(false);
+    expect(ui()).toHaveLogged(
+      'warn',
+      'Environment variable CP_VERBOSE expected to be a boolean (true/false/1/0), but received value unexpected. Treating it as disabled.',
+    );
+  });
+});

packages/utils/src/lib/execute-process.ts

@@ -6,8 +6,9 @@ import {
   spawn,
 } from 'node:child_process';
 import type { Readable, Writable } from 'node:stream';
+import { isVerbose } from './env.js';
 import { formatCommandLog } from './format-command-log.js';
-import { isVerbose, ui } from './logging.js';
+import { ui } from './logging.js';
 import { calcDuration } from './reports/utils.js';
 
 /**

packages/utils/src/lib/logging.ts

@@ -19,8 +19,6 @@ export type Column = {
 };
 export type CliUi = CliUiBase & CliExtension;
 
-export const isVerbose = () => process.env['CP_VERBOSE'] === 'true';
-
 // eslint-disable-next-line functional/no-let
 let cliUISingleton: CliUiBase | undefined;
 // eslint-disable-next-line functional/no-let

packages/utils/src/lib/reports/log-stdout-summary.ts

@@ -1,6 +1,7 @@
 import { bold, cyan, cyanBright, green, red } from 'ansis';
 import type { AuditReport } from '@code-pushup/models';
-import { isVerbose, ui } from '../logging.js';
+import { isVerbose } from '../env.js';
+import { ui } from '../logging.js';
 import {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,