feat(cli): include logo and version in initial log

matejchalk · matejchalk · commit 52266a7f8bca · 2025-12-09T09:51:02.000+01:00
diff --git a/packages/cli/src/lib/autorun/autorun-command.ts b/packages/cli/src/lib/autorun/autorun-command.ts
@@ -1,4 +1,3 @@
-import ansis from 'ansis';
 import type { ArgumentsCamelCase, CommandModule } from 'yargs';
 import {
   type CollectOptions,
@@ -7,9 +6,9 @@ import {
   upload,
 } from '@code-pushup/core';
 import { logger } from '@code-pushup/utils';
-import { CLI_NAME } from '../constants.js';
 import {
   collectSuccessfulLog,
+  printCliCommand,
   renderConfigureCategoriesHint,
   renderIntegratePortalHint,
   uploadSuccessfulLog,
@@ -23,8 +22,8 @@ export function yargsAutorunCommandObject() {
     command,
     describe: 'Shortcut for running collect followed by upload',
     handler: async <T>(args: ArgumentsCamelCase<T>) => {
-      logger.info(ansis.bold(CLI_NAME));
-      logger.debug(`Running ${ansis.bold(command)} command`);
+      printCliCommand(command);
+
       const options = args as unknown as AutorunOptions;
 
       // we need to ensure `json` is part of the formats as we want to upload
diff --git a/packages/cli/src/lib/cli.ts b/packages/cli/src/lib/cli.ts
@@ -1,12 +1,12 @@
 import { commands } from './commands.js';
-import { CLI_NAME, CLI_SCRIPT_NAME } from './constants.js';
+import { CLI_DISPLAY_NAME, CLI_SCRIPT_NAME } from './constants.js';
 import { middlewares } from './middlewares.js';
 import { groups, options } from './options.js';
 import { yargsCli } from './yargs-cli.js';
 
 export const cli = (args: string[]) =>
   yargsCli(args, {
-    usageMessage: CLI_NAME,
+    usageMessage: CLI_DISPLAY_NAME,
     scriptName: CLI_SCRIPT_NAME,
     options,
     groups,
diff --git a/packages/cli/src/lib/collect/collect-command.ts b/packages/cli/src/lib/collect/collect-command.ts
@@ -9,9 +9,9 @@ import {
   formatAsciiSticker,
   logger,
 } from '@code-pushup/utils';
-import { CLI_NAME } from '../constants.js';
 import {
   collectSuccessfulLog,
+  printCliCommand,
   renderConfigureCategoriesHint,
 } from '../implementation/logging.js';
 
@@ -21,9 +21,9 @@ export function yargsCollectCommandObject(): CommandModule {
     command,
     describe: 'Run Plugins and collect results',
     handler: async <T>(args: ArgumentsCamelCase<T>) => {
+      printCliCommand(command);
+
       const options = args as unknown as CollectAndPersistReportsOptions;
-      logger.info(ansis.bold(CLI_NAME));
-      logger.debug(`Running ${ansis.bold(command)} command`);
 
       await collectAndPersistReports(options);
       collectSuccessfulLog();
diff --git a/packages/cli/src/lib/compare/compare-command.ts b/packages/cli/src/lib/compare/compare-command.ts
@@ -3,8 +3,8 @@ import type { CommandModule } from 'yargs';
 import { type CompareOptions, compareReportFiles } from '@code-pushup/core';
 import type { PersistConfig, UploadConfig } from '@code-pushup/models';
 import { logger } from '@code-pushup/utils';
-import { CLI_NAME } from '../constants.js';
 import { yargsCompareOptionsDefinition } from '../implementation/compare.options.js';
+import { printCliCommand } from '../implementation/logging.js';
 
 export function yargsCompareCommandObject() {
   const command = 'compare';
@@ -13,8 +13,7 @@ export function yargsCompareCommandObject() {
     describe: 'Compare 2 report files and create a diff file',
     builder: yargsCompareOptionsDefinition(),
     handler: async (args: unknown) => {
-      logger.info(ansis.bold(CLI_NAME));
-      logger.debug(`Running ${ansis.bold(command)} command`);
+      printCliCommand(command);
 
       const options = args as CompareOptions & {
         persist: Required<PersistConfig>;
diff --git a/packages/cli/src/lib/constants.ts b/packages/cli/src/lib/constants.ts
@@ -1,2 +1,2 @@
-export const CLI_NAME = 'Code PushUp CLI';
+export const CLI_DISPLAY_NAME = 'Code PushUp CLI';
 export const CLI_SCRIPT_NAME = 'code-pushup';
diff --git a/packages/cli/src/lib/history/history-command.ts b/packages/cli/src/lib/history/history-command.ts
@@ -1,4 +1,3 @@
-import ansis from 'ansis';
 import type { CommandModule } from 'yargs';
 import { type HistoryOptions, history } from '@code-pushup/core';
 import {
@@ -9,16 +8,15 @@ import {
   logger,
   safeCheckout,
 } from '@code-pushup/utils';
-import { CLI_NAME } from '../constants.js';
 import { yargsFilterOptionsDefinition } from '../implementation/filter.options.js';
+import { printCliCommand } from '../implementation/logging.js';
 import type { HistoryCliOptions } from './history.model.js';
 import { yargsHistoryOptionsDefinition } from './history.options.js';
 import { normalizeHashOptions } from './utils.js';
 
 const command = 'history';
 async function handler(args: unknown) {
-  logger.info(ansis.bold(CLI_NAME));
-  logger.debug(`Running ${ansis.bold(command)} command`);
+  printCliCommand(command);
 
   const currentBranch = await getCurrentBranchOrTag();
   const { targetBranch: rawTargetBranch, ...opt } = args as HistoryCliOptions &
diff --git a/packages/cli/src/lib/implementation/log-intro-middleware.unit.test.ts b/packages/cli/src/lib/implementation/log-intro-middleware.unit.test.ts
@@ -0,0 +1,17 @@
+import type { ArgumentsCamelCase } from 'yargs';
+import { logger } from '@code-pushup/utils';
+import { logIntroMiddleware } from './log-intro.middleware';
+
+describe('logIntroMiddleware', () => {
+  it('should print logo, name and version', () => {
+    logIntroMiddleware({ $0: 'code-pushup', _: ['collect'] });
+    expect(logger.info).toHaveBeenCalledWith(
+      expect.stringMatching(/<✓> Code PushUp CLI v\d+\.\d+\.\d+/),
+    );
+  });
+
+  it('should not change arguments', () => {
+    const args: ArgumentsCamelCase = { $0: 'code-pushup', _: ['collect'] };
+    expect(logIntroMiddleware(args)).toBe(args);
+  });
+});
diff --git a/packages/cli/src/lib/implementation/log-intro.middleware.ts b/packages/cli/src/lib/implementation/log-intro.middleware.ts
@@ -0,0 +1,20 @@
+import ansis from 'ansis';
+import type { ArgumentsCamelCase } from 'yargs';
+import { CODE_PUSHUP_UNICODE_LOGO, logger } from '@code-pushup/utils';
+import { CLI_DISPLAY_NAME } from '../constants.js';
+import { getVersion } from './version.js';
+
+export function logIntroMiddleware(
+  args: ArgumentsCamelCase,
+): ArgumentsCamelCase {
+  // prevent interference with JSON output
+  if (args._.includes('print-config') && !('output' in args)) {
+    return args;
+  }
+  logger.info(
+    ansis.bold.blue(
+      `${CODE_PUSHUP_UNICODE_LOGO} ${CLI_DISPLAY_NAME} v${getVersion()}`,
+    ),
+  );
+  return args;
+}
diff --git a/packages/cli/src/lib/implementation/logging.ts b/packages/cli/src/lib/implementation/logging.ts
@@ -5,6 +5,10 @@ import {
   logger,
 } from '@code-pushup/utils';
 
+export function printCliCommand(command: string): void {
+  logger.debug(`Running ${ansis.bold(command)} command\n`);
+}
+
 export function renderConfigureCategoriesHint(): void {
   logger.debug(
     `💡 Configure categories to see the scores in an overview table. See: ${formatAsciiLink(
diff --git a/packages/cli/src/lib/implementation/version.ts b/packages/cli/src/lib/implementation/version.ts
@@ -0,0 +1,8 @@
+import { createRequire } from 'node:module';
+
+export function getVersion(): string {
+  const packageJson = createRequire(import.meta.url)(
+    '../../../package.json',
+  ) as typeof import('../../../package.json');
+  return packageJson.version;
+}
diff --git a/packages/cli/src/lib/merge-diffs/merge-diffs-command.ts b/packages/cli/src/lib/merge-diffs/merge-diffs-command.ts
@@ -3,7 +3,7 @@ import type { CommandModule } from 'yargs';
 import { mergeDiffs } from '@code-pushup/core';
 import type { PersistConfig } from '@code-pushup/models';
 import { logger } from '@code-pushup/utils';
-import { CLI_NAME } from '../constants.js';
+import { printCliCommand } from '../implementation/logging.js';
 import type { MergeDiffsOptions } from '../implementation/merge-diffs.model.js';
 import { yargsMergeDiffsOptionsDefinition } from '../implementation/merge-diffs.options.js';
 
@@ -14,8 +14,7 @@ export function yargsMergeDiffsCommandObject() {
     describe: 'Combine many report diffs into a single diff file',
     builder: yargsMergeDiffsOptionsDefinition(),
     handler: async (args: unknown) => {
-      logger.info(ansis.bold(CLI_NAME));
-      logger.debug(`Running ${ansis.bold(command)} command`);
+      printCliCommand(command);
 
       const options = args as MergeDiffsOptions & {
         persist: Required<PersistConfig>;
diff --git a/packages/cli/src/lib/middlewares.ts b/packages/cli/src/lib/middlewares.ts
@@ -1,11 +1,16 @@
 import type { MiddlewareFunction } from 'yargs';
 import { coreConfigMiddleware } from './implementation/core-config.middleware.js';
 import { filterMiddleware } from './implementation/filter.middleware.js';
+import { logIntroMiddleware } from './implementation/log-intro.middleware.js';
 import { setVerboseMiddleware } from './implementation/set-verbose.middleware.js';
 
 export const middlewares = [
   {
-    middlewareFunction: setVerboseMiddleware as unknown as MiddlewareFunction,
+    middlewareFunction: logIntroMiddleware,
+    applyBeforeValidation: true,
+  },
+  {
+    middlewareFunction: setVerboseMiddleware as MiddlewareFunction,
     applyBeforeValidation: false,
   },
   {
diff --git a/packages/cli/src/lib/print-config/print-config-command.ts b/packages/cli/src/lib/print-config/print-config-command.ts
@@ -4,6 +4,7 @@ import path from 'node:path';
 import type { CommandModule } from 'yargs';
 import { logger } from '@code-pushup/utils';
 import { filterKebabCaseKeys } from '../implementation/global.utils.js';
+import { printCliCommand } from '../implementation/logging.js';
 import type { PrintConfigOptions } from '../implementation/print-config.model.js';
 import { yargsPrintConfigOptionsDefinition } from '../implementation/print-config.options.js';
 
@@ -20,6 +21,11 @@ export function yargsPrintConfigCommandObject() {
       const { output, ...config } = args as PrintConfigOptions &
         Record<string, unknown>;
 
+      // stdout should be valid JSON
+      if (output) {
+        printCliCommand(command);
+      }
+
       const content = JSON.stringify(config, null, 2);
 
       if (output) {
diff --git a/packages/cli/src/lib/upload/upload-command.ts b/packages/cli/src/lib/upload/upload-command.ts
@@ -1,9 +1,7 @@
-import ansis from 'ansis';
 import type { ArgumentsCamelCase, CommandModule } from 'yargs';
 import { type UploadOptions, upload } from '@code-pushup/core';
-import { logger } from '@code-pushup/utils';
-import { CLI_NAME } from '../constants.js';
 import {
+  printCliCommand,
   renderIntegratePortalHint,
   uploadSuccessfulLog,
 } from '../implementation/logging.js';
@@ -14,8 +12,7 @@ export function yargsUploadCommandObject() {
     command,
     describe: 'Upload report results to the portal',
     handler: async <T>(args: ArgumentsCamelCase<T>) => {
-      logger.info(ansis.bold(CLI_NAME));
-      logger.debug(`Running ${ansis.bold(command)} command`);
+      printCliCommand(command);
 
       const options = args as unknown as UploadOptions;
       if (options.upload == null) {
diff --git a/packages/cli/src/lib/yargs-cli.ts b/packages/cli/src/lib/yargs-cli.ts
@@ -1,6 +1,5 @@
 /* eslint-disable max-lines-per-function */
 import ansis from 'ansis';
-import { createRequire } from 'node:module';
 import yargs, {
   type Argv,
   type CommandModule,
@@ -22,6 +21,7 @@ import {
   titleStyle,
 } from './implementation/formatting.js';
 import { logErrorBeforeThrow } from './implementation/global.utils.js';
+import { getVersion } from './implementation/version.js';
 
 export const yargsDecorator = {
   'Commands:': `${ansis.green('Commands')}:`,
@@ -54,7 +54,7 @@ export function yargsCli<T = unknown>(
     groups?: { [key: string]: string[] };
     examples?: [string, string][];
     middlewares?: {
-      middlewareFunction: unknown;
+      middlewareFunction: MiddlewareFunction;
       applyBeforeValidation?: boolean;
     }[];
     noExitProcess?: boolean;
@@ -68,10 +68,6 @@ export function yargsCli<T = unknown>(
   const examples = cfg.examples ?? [];
   const cli = yargs(argv);
 
-  const packageJson = createRequire(import.meta.url)(
-    '../../package.json',
-  ) as typeof import('../../package.json');
-
   // setup yargs
   cli
     .updateLocale(yargsDecorator)
@@ -80,7 +76,7 @@ export function yargsCli<T = unknown>(
     .help('help', descriptionStyle('Show help'))
     .alias('h', 'help')
     .showHelpOnFail(false)
-    .version('version', ansis.dim('Show version'), packageJson.version)
+    .version('version', ansis.dim('Show version'), getVersion())
     .check(args => {
       const persist = args['persist'] as PersistConfig | undefined;
       return persist == null || validatePersistFormat(persist);
@@ -116,7 +112,7 @@ export function yargsCli<T = unknown>(
   // add middlewares
   middlewares.forEach(({ middlewareFunction, applyBeforeValidation }) => {
     cli.middleware(
-      logErrorBeforeThrow(middlewareFunction as MiddlewareFunction),
+      logErrorBeforeThrow(middlewareFunction),
       applyBeforeValidation,
     );
   });

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-export const CLI_NAME = 'Code PushUp CLI';`
	`1`	`+export const CLI_DISPLAY_NAME = 'Code PushUp CLI';`
`2`	`2`	`export const CLI_SCRIPT_NAME = 'code-pushup';`