feat(utils): add noLineBreak and noIndent options to logger methods

Author: matejchalk

packages/utils/src/lib/logger.int.test.ts

@@ -129,6 +129,19 @@ ${ansis.red('Failed to load config')}
       );
     });
 
+    it('should skip line-break if requested', () => {
+      const logger = new Logger();
+
+      logger.info('Code PushUp CLI', { noLineBreak: true });
+      logger.debug(' - v1.2.3', { noLineBreak: true, force: true });
+      logger.warn(' (Config file in CommonJS format)', { noLineBreak: true });
+      logger.error(' => Failed to load config', { noLineBreak: true });
+
+      expect(stdout).toBe(
+        `Code PushUp CLI${ansis.gray(' - v1.2.3')}${ansis.yellow(' (Config file in CommonJS format)')}${ansis.red(' => Failed to load config')}`,
+      );
+    });
+
     it('should set verbose flag and environment variable', () => {
       vi.stubEnv('CP_VERBOSE', 'false');
       const logger = new Logger();
@@ -592,6 +605,40 @@ ${ansis.red('✖')} Uploading report to portal → ${ansis.red('GraphQL error: I
         `${ansis.green('✔')} ${ansis.blue('src')} ${ansis.green('$')} npx eslint . --format=json ${ansis.gray('(42 ms)')}\n`,
       );
     });
+
+    it('should skip indentation for inner logs in CI if requested', async () => {
+      vi.stubEnv('CI', 'true');
+      const logger = new Logger();
+
+      await logger.command('npx code-pushup', async () => {
+        logger.newline();
+        logger.info(
+          '::group::npx nx lint\nAll files pass linting.\n::endgroup\n',
+          { noIndent: true },
+        );
+        logger.info(
+          'Collected report:\n- .code-pushup/report.json\n- .code-pushup/report.md',
+          { noIndent: true },
+        );
+        logger.newline();
+      });
+
+      expect(ansis.strip(stdout)).toBe(
+        `
+- $ npx code-pushup
+
+::group::npx nx lint
+All files pass linting.
+::endgroup
+
+Collected report:
+- .code-pushup/report.json
+- .code-pushup/report.md
+
+✔ $ npx code-pushup (42 ms)
+`.trimStart(),
+      );
+    });
   });
 
   describe('spinners + groups', () => {

packages/utils/src/lib/logger.ts

@@ -12,6 +12,20 @@ import { settlePromise } from './promises.js';
 type GroupColor = Extract<AnsiColors, 'cyan' | 'magenta'>;
 type CiPlatform = 'GitHub Actions' | 'GitLab CI/CD';
 
+/** Additional options for log methods */
+export type LogOptions = {
+  /** Do not append line-feed to message (`process.stdout.write` instead of `console.log`) */
+  noLineBreak?: boolean;
+  /** Do not indent lines even if logged while a spinner is active */
+  noIndent?: boolean;
+};
+
+/** Additional options for {@link Logger.debug} method */
+export type DebugLogOptions = LogOptions & {
+  /** Print debug message even if verbose flag is not set */
+  force?: boolean;
+};
+
 const HEX_RADIX = 16;
 
 const SIGINT_CODE = 2;
@@ -79,9 +93,10 @@ export class Logger {
    * logger.error('Config file is invalid');
    *
    * @param message Error text
+   * @param options Additional options
    */
-  error(message: string): void {
-    this.#log(message, 'red');
+  error(message: string, options?: LogOptions): void {
+    this.#log(message, 'red', options);
   }
 
   /**
@@ -93,9 +108,10 @@ export class Logger {
    * logger.warn('Skipping invalid audits');
    *
    * @param message Warning text
+   * @param options Additional options
    */
-  warn(message: string): void {
-    this.#log(message, 'yellow');
+  warn(message: string, options?: LogOptions): void {
+    this.#log(message, 'yellow', options);
   }
 
   /**
@@ -107,9 +123,10 @@ export class Logger {
    * logger.info('Code PushUp CLI v0.80.2');
    *
    * @param message Info text
+   * @param options Additional options
    */
-  info(message: string): void {
-    this.#log(message);
+  info(message: string, options?: LogOptions): void {
+    this.#log(message, undefined, options);
   }
 
   /**
@@ -122,11 +139,10 @@ export class Logger {
    *
    * @param message Debug text
    * @param options Additional options
-   * @param options.force Print debug message even if verbose flag is not set
    */
-  debug(message: string, options?: { force?: boolean }): void {
+  debug(message: string, options?: DebugLogOptions): void {
     if (this.#isVerbose || options?.force) {
-      this.#log(message, 'gray');
+      this.#log(message, 'gray', options);
     }
   }
 
@@ -457,17 +473,24 @@ export class Logger {
     return result.value;
   }
 
-  #log(message: string, color?: AnsiColors): void {
+  #log(message: string, color?: AnsiColors, options?: LogOptions): void {
+    const print: (text: string) => void = options?.noLineBreak
+      ? text => process.stdout.write(text)
+      : console.log;
+
     if (this.#activeSpinner) {
       if (this.#activeSpinner.isSpinning) {
         this.#activeSpinnerLogs.push(this.#format(message, color));
       } else {
-        console.log(this.#format(indentLines(message, 2), color));
+        const indented =
+          options?.noIndent || !message ? message : indentLines(message, 2);
+        print(this.#format(indented, color));
       }
     } else {
-      console.log(this.#format(message, color));
+      print(this.#format(message, color));
     }
-    this.#endsWithBlankLine = !message || message.endsWith('\n');
+    this.#endsWithBlankLine =
+      (!message || message.endsWith('\n')) && !options?.noIndent;
   }
 
   #format(message: string, color: AnsiColors | undefined): string {