refactor(utils): use cliui as central logger

code-pushup.config.ts

@@ -51,7 +51,7 @@ const config: CoreConfig = {
 
   plugins: [
     await eslintPlugin(await eslintConfigFromNxProjects()),
-    await coveragePlugin({
+    /*await coveragePlugin({
       coverageToolCommand: {
         command: 'npx',
         args: [
@@ -65,7 +65,7 @@ const config: CoreConfig = {
         ],
       },
       reports: await getNxCoveragePaths(['unit-test', 'integration-test']),
-    }),
+    }),*/
     fileSizePlugin({
       directory: './dist/examples/react-todos-app',
       pattern: /\.js$/,
@@ -98,7 +98,7 @@ const config: CoreConfig = {
         { type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1 },
       ],
     },
-    {
+    /*  {
       slug: 'code-coverage',
       title: 'Code coverage',
       refs: [
@@ -109,7 +109,7 @@ const config: CoreConfig = {
           weight: 1,
         },
       ],
-    },
+    },*/
     {
       slug: 'custom-checks',
       title: 'Custom checks',

package.json

@@ -48,7 +48,7 @@
   "dependencies": {
     "@code-pushup/portal-client": "^0.6.1",
     "@isaacs/cliui": "^8.0.2",
-    "@poppinss/cliui": "^6.3.0",
+    "@poppinss/cliui": "^6.4.0",
     "@swc/helpers": "0.5.3",
     "bundle-require": "^4.0.1",
     "chalk": "^5.3.0",

packages/cli/package.json

@@ -10,7 +10,6 @@
     "@code-pushup/core": "*",
     "yargs": "^17.7.2",
     "chalk": "^5.3.0",
-    "@code-pushup/utils": "*",
-    "@poppinss/cliui": "^6.3.0"
+    "@code-pushup/utils": "*"
   }
 }

packages/cli/src/lib/autorun/autorun-command.ts

@@ -6,12 +6,12 @@ import {
   collectAndPersistReports,
   upload,
 } from '@code-pushup/core';
+import { ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   collectSuccessfulLog,
   renderConfigureCategoriesHint,
   renderIntegratePortalHint,
-  ui,
   uploadSuccessfulLog,
 } from '../implementation/logging';
 import { yargsOnlyPluginsOptionsDefinition } from '../implementation/only-plugins.options';

packages/cli/src/lib/collect/collect-command.ts

@@ -4,12 +4,11 @@ import {
   CollectAndPersistReportsOptions,
   collectAndPersistReports,
 } from '@code-pushup/core';
-import { link } from '@code-pushup/utils';
+import { link, ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   collectSuccessfulLog,
   renderConfigureCategoriesHint,
-  ui,
 } from '../implementation/logging';
 import { yargsOnlyPluginsOptionsDefinition } from '../implementation/only-plugins.options';
 

packages/cli/src/lib/implementation/logging.ts

@@ -1,17 +1,5 @@
-import { cliui } from '@poppinss/cliui';
 import chalk from 'chalk';
-import { link } from '@code-pushup/utils';
-
-export type CliUi = ReturnType<typeof cliui>;
-
-// eslint-disable-next-line import/no-mutable-exports,functional/no-let
-export let singletonUiInstance: CliUi | undefined;
-export function ui(): CliUi {
-  if (singletonUiInstance === undefined) {
-    singletonUiInstance = cliui();
-  }
-  return singletonUiInstance;
-}
+import { link, ui } from '@code-pushup/utils';
 
 export function renderConfigureCategoriesHint(): void {
   ui().logger.info(
@@ -26,6 +14,7 @@ export function uploadSuccessfulLog(url: string): void {
   ui().logger.success('Upload successful!');
   ui().logger.success(link(url));
 }
+
 export function collectSuccessfulLog(): void {
   ui().logger.success('Collecting report successful!');
 }

packages/cli/src/lib/implementation/only-plugins.utils.ts

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import type { CategoryConfig, CoreConfig } from '@code-pushup/models';
+import { ui } from '@code-pushup/utils';
 
 export function filterPluginsBySlug(
   plugins: CoreConfig['plugins'],
@@ -32,7 +33,7 @@ export function filterCategoryByPluginSlug(
       const isNotSkipped = onlyPlugins.includes(ref.plugin);
 
       if (!isNotSkipped && verbose) {
-        console.info(
+        ui().logger.info(
           `${chalk.yellow('⚠')} Category "${
             category.title
           }" is ignored because it references audits from skipped plugin "${
@@ -58,7 +59,7 @@ export function validateOnlyPluginsOption(
     : [];
 
   if (missingPlugins.length > 0 && verbose) {
-    console.warn(
+    ui().logger.warning(
       `${chalk.yellow(
         '⚠',
       )} The --onlyPlugin argument references plugins with "${missingPlugins.join(

packages/cli/src/lib/implementation/only-plugins.utils.unit.test.ts

@@ -1,5 +1,7 @@
 import { describe, expect } from 'vitest';
 import { CategoryConfig, CoreConfig } from '@code-pushup/models';
+import { getLogMessages } from '@code-pushup/test-utils';
+import { ui } from '@code-pushup/utils';
 import {
   filterCategoryByPluginSlug,
   filterPluginsBySlug,
@@ -86,10 +88,11 @@ describe('filterCategoryByPluginSlug', () => {
         verbose: true,
       },
     );
-    expect(console.info).toHaveBeenCalledWith(
-      expect.stringContaining('"category1" is ignored'),
+    const logs = getLogMessages(ui().logger);
+    expect(logs[0]).toEqual(
+      expect.stringContaining('Category "category1" is ignored'),
     );
-    expect(console.info).toHaveBeenCalledWith(
+    expect(logs[0]).toEqual(
       expect.stringContaining('skipped plugin "plugin2"'),
     );
   });
@@ -110,9 +113,10 @@ describe('validateOnlyPluginsOption', () => {
         verbose: true,
       },
     );
-    expect(console.warn).toHaveBeenCalledWith(
+    const logs = getLogMessages(ui().logger);
+    expect(logs[0]).toEqual(
       expect.stringContaining(
-        'plugins with "plugin3", "plugin4" slugs, but no such plugins are present',
+        'The --onlyPlugin argument references plugins with "plugin3", "plugin4" slugs',
       ),
     );
   });
@@ -125,6 +129,6 @@ describe('validateOnlyPluginsOption', () => {
         verbose: true,
       },
     );
-    expect(console.warn).not.toHaveBeenCalled();
+    expect(getLogMessages(ui().logger)).toHaveLength(0);
   });
 });

packages/cli/src/lib/print-config/print-config-command.ts

@@ -1,6 +1,6 @@
 import { CommandModule } from 'yargs';
+import { ui } from '@code-pushup/utils';
 import { filterKebabCaseKeys } from '../implementation/global.utils';
-import { ui } from '../implementation/logging';
 import { onlyPluginsOption } from '../implementation/only-plugins.options';
 
 export function yargsConfigCommandObject() {

packages/cli/src/lib/print-config/print-config-command.unit.test.ts

@@ -1,6 +1,7 @@
-import { beforeAll, describe, expect } from 'vitest';
+import { describe, expect, vi } from 'vitest';
+import { getLogMessages } from '@code-pushup/test-utils';
+import { ui } from '@code-pushup/utils';
 import { DEFAULT_CLI_CONFIGURATION } from '../../../mocks/constants';
-import { ui } from '../implementation/logging';
 import { yargsCli } from '../yargs-cli';
 import { yargsConfigCommandObject } from './print-config-command';
 
@@ -15,11 +16,6 @@ vi.mock('@code-pushup/core', async () => {
 });
 
 describe('print-config-command', () => {
-  beforeAll(() => {
-    // initialize it in raw mode
-    ui().switchMode('raw');
-  });
-
   it('should filter out meta arguments and kebab duplicates', async () => {
     await yargsCli(
       [
@@ -31,30 +27,13 @@ describe('print-config-command', () => {
       { ...DEFAULT_CLI_CONFIGURATION, commands: [yargsConfigCommandObject()] },
     ).parseAsync();
 
-    const log = ui().logger.getLogs()[0];
-
-    expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.not.stringContaining('"$0":'),
-      }),
-    );
-
-    expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.not.stringContaining('"_":'),
-      }),
-    );
-
-    expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.stringContaining('"outputDir": "destinationDir"'),
-      }),
-    );
+    const log = getLogMessages(ui().logger)[0];
+    expect(log).toEqual(expect.not.stringContaining('"$0":'));
+    expect(log).toEqual(expect.not.stringContaining('"_":'));
 
     expect(log).toEqual(
-      expect.objectContaining({
-        message: expect.not.stringContaining('"output-dir":'),
-      }),
+      expect.stringContaining('"outputDir": "destinationDir"'),
     );
+    expect(log).toEqual(expect.not.stringContaining('"output-dir":'));
   });
 });

packages/cli/src/lib/upload/upload-command.ts

@@ -1,10 +1,10 @@
 import chalk from 'chalk';
 import { ArgumentsCamelCase, CommandModule } from 'yargs';
 import { UploadOptions, upload } from '@code-pushup/core';
+import { ui } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   renderIntegratePortalHint,
-  ui,
   uploadSuccessfulLog,
 } from '../implementation/logging';
 

packages/cli/vite.config.unit.ts

@@ -21,6 +21,7 @@ export default defineConfig({
     include: ['src/**/*.unit.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
     globalSetup: ['../../global-setup.ts'],
     setupFiles: [
+      '../../testing/test-setup/src/lib/cliui.mock.ts',
       '../../testing/test-setup/src/lib/fs.mock.ts',
       '../../testing/test-setup/src/lib/git.mock.ts',
       '../../testing/test-setup/src/lib/console.mock.ts',

packages/core/src/lib/implementation/execute-plugin.ts

@@ -142,12 +142,10 @@ export async function executePlugins(
 
   progressBar?.endProgress('Done running plugins');
 
-  const errorsCallback = ({ reason }: PromiseRejectedResult) => {
-    console.error(reason);
-  };
+  const errorsTransform = ({ reason }: PromiseRejectedResult) => String(reason);
   const results = await Promise.allSettled(pluginsResult);
 
-  logMultipleResults(results, 'Plugins', undefined, errorsCallback);
+  logMultipleResults(results, 'Plugins', undefined, errorsTransform);
 
   const { fulfilled, rejected } = groupByStatus(results);
   if (rejected.length > 0) {