feat(plugin-coverage): log initializer and nx helper steps

Author: matejchalk

packages/plugin-coverage/src/lib/constants.ts

@@ -0,0 +1,2 @@
+export const COVERAGE_PLUGIN_SLUG = 'coverage';
+export const COVERAGE_PLUGIN_TITLE = 'Code coverage';

packages/plugin-coverage/src/lib/coverage-plugin.ts

@@ -5,12 +5,14 @@ import {
   type PluginConfig,
   validate,
 } from '@code-pushup/models';
-import { capitalize } from '@code-pushup/utils';
+import { capitalize, logger, pluralizeToken } from '@code-pushup/utils';
 import {
   type CoveragePluginConfig,
   type CoverageType,
   coveragePluginConfigSchema,
 } from './config.js';
+import { COVERAGE_PLUGIN_SLUG, COVERAGE_PLUGIN_TITLE } from './constants.js';
+import { formatMetaLog } from './format.js';
 import { createRunnerFunction } from './runner/runner.js';
 import { coverageDescription, coverageTypeWeightMapper } from './utils.js';
 
@@ -58,15 +60,21 @@ export async function coveragePlugin(
     })),
   };
 
+  logger.info(
+    formatMetaLog(
+      `Created ${pluralizeToken('audit', audits.length)} (${coverageConfig.coverageTypes.join('/')} coverage) and 1 group`,
+    ),
+  );
+
   const packageJson = createRequire(import.meta.url)(
     '../../package.json',
   ) as typeof import('../../package.json');
 
   const scoreTargets = coverageConfig.scoreTargets;
 
   return {
-    slug: 'coverage',
-    title: 'Code coverage',
+    slug: COVERAGE_PLUGIN_SLUG,
+    title: COVERAGE_PLUGIN_TITLE,
     icon: 'folder-coverage-open',
     description: 'Official Code PushUp code coverage plugin.',
     docsUrl: 'https://www.npmjs.com/package/@code-pushup/coverage-plugin/',

packages/plugin-coverage/src/lib/format.ts

@@ -0,0 +1,4 @@
+import { pluginMetaLogFormatter } from '@code-pushup/utils';
+import { COVERAGE_PLUGIN_TITLE } from './constants.js';
+
+export const formatMetaLog = pluginMetaLogFormatter(COVERAGE_PLUGIN_TITLE);

packages/plugin-coverage/src/lib/nx/coverage-paths.ts

@@ -7,8 +7,15 @@ import type {
 import type { JestExecutorOptions } from '@nx/jest/src/executors/jest/schema';
 import type { VitestExecutorOptions } from '@nx/vite/executors';
 import path from 'node:path';
-import { importModule, logger, stringifyError } from '@code-pushup/utils';
+import {
+  importModule,
+  logger,
+  pluralize,
+  pluralizeToken,
+  stringifyError,
+} from '@code-pushup/utils';
 import type { CoverageResult } from '../config.js';
+import { formatMetaLog } from '../format.js';
 
 /**
  * Resolves the cached project graph for the current Nx workspace.
@@ -21,9 +28,8 @@ async function resolveCachedProjectGraph() {
   try {
     return readCachedProjectGraph();
   } catch (error) {
-    logger.info(
-      `Could not read cached project graph, falling back to async creation.
-      ${stringifyError(error)}`,
+    logger.warn(
+      `Could not read cached project graph, falling back to async creation - ${stringifyError(error)}`,
     );
     return await createProjectGraphAsync({ exitOnError: false });
   }
@@ -36,29 +42,52 @@ async function resolveCachedProjectGraph() {
 export async function getNxCoveragePaths(
   targets: string[] = ['test'],
 ): Promise<CoverageResult[]> {
-  logger.debug('💡 Gathering coverage from the following nx projects:');
-
   const { nodes } = await resolveCachedProjectGraph();
 
-  const coverageResults = await Promise.all(
-    targets.map(async target => {
-      const relevantNodes = Object.values(nodes).filter(graph =>
-        hasNxTarget(graph, target),
-      );
-
-      return await Promise.all(
-        relevantNodes.map<Promise<CoverageResult>>(async ({ name, data }) => {
-          const coveragePaths = await getCoveragePathsForTarget(data, target);
-          logger.debug(`- ${name}: ${target}`);
-          return coveragePaths;
-        }),
-      );
-    }),
+  const coverageResultsPerTarget = Object.fromEntries(
+    await Promise.all(
+      targets.map(async (target): Promise<[string, CoverageResult[]]> => {
+        const relevantNodes = Object.values(nodes).filter(graph =>
+          hasNxTarget(graph, target),
+        );
+
+        return [
+          target,
+          await Promise.all(
+            relevantNodes.map(({ data }) =>
+              getCoveragePathsForTarget(data, target),
+            ),
+          ),
+        ];
+      }),
+    ),
   );
 
-  logger.debug('');
+  const coverageResults = Object.values(coverageResultsPerTarget).flat();
+
+  logger.info(
+    formatMetaLog(
+      `Inferred ${pluralizeToken('coverage report', coverageResults.length)} from Nx projects with ${pluralize('target', targets.length)} ${
+        targets.length === 1
+          ? targets[0]
+          : Object.entries(coverageResultsPerTarget)
+              .map(([target, results]) => `${target} (${results.length})`)
+              .join(' and ')
+      }`,
+    ),
+  );
+  logger.debug(
+    formatMetaLog(
+      coverageResults
+        .map(
+          result =>
+            `• ${typeof result === 'string' ? result : result.resultsPath}`,
+        )
+        .join('\n'),
+    ),
+  );
 
-  return coverageResults.flat();
+  return coverageResults;
 }
 
 function hasNxTarget(