wip: add time option for Logger#logMessage

Author: mizdra

packages/codegen/src/logger/formatter.test.ts

@@ -1,7 +1,7 @@
 import dedent from 'dedent';
 import ts from 'typescript';
 import { describe, expect, test } from 'vitest';
-import { formatDiagnostics } from './formatter';
+import { formatDiagnostics, formatTime } from './formatter';
 
 describe('formatDiagnostics', () => {
   const file = ts.createSourceFile(
@@ -66,3 +66,13 @@ describe('formatDiagnostics', () => {
     `);
   });
 });
+
+test('formatTime', () => {
+  const date = new Date('2023-01-01T00:00:00Z');
+  expect(formatTime(date, true)).toMatchInlineSnapshot(`
+    "[12:00:00 AM]"
+  `);
+  expect(formatTime(date, false)).toMatchInlineSnapshot(`
+    "[12:00:00 AM]"
+  `);
+});

packages/codegen/src/logger/formatter.ts

@@ -1,5 +1,8 @@
 import ts from 'typescript';
 
+const GRAY = '\u001b[90m';
+const RESET = '\u001b[0m';
+
 export function formatDiagnostics(
   diagnostics: ts.Diagnostic[],
   host: ts.FormatDiagnosticsHost,
@@ -12,3 +15,12 @@ export function formatDiagnostics(
   }
   return result;
 }
+
+export function formatTime(date: Date, pretty: boolean): string {
+  const text = date.toLocaleTimeString('en-US', { timeZone: 'UTC' });
+  if (pretty) {
+    return `[${GRAY}${text}${RESET}]`;
+  } else {
+    return `[${text}]`;
+  }
+}

packages/codegen/src/logger/logger.test.ts

@@ -7,6 +7,10 @@ import { createLogger } from './logger.js';
 const stdoutWriteSpy = vi.spyOn(process.stdout, 'write').mockImplementation(() => true);
 const stderrWriteSpy = vi.spyOn(process.stderr, 'write').mockImplementation(() => true);
 
+const date = new Date('2023-01-01T00:00:00Z');
+vi.useRealTimers();
+vi.setSystemTime(date);
+
 const cwd = '/app';
 
 describe('createLogger', () => {
@@ -58,5 +62,7 @@ describe('createLogger', () => {
     const logger = createLogger(cwd, false);
     logger.logMessage('message');
     expect(stdoutWriteSpy).toHaveBeenCalledWith('message\n');
+    logger.logMessage('message with time', { time: true });
+    expect(stdoutWriteSpy).toHaveBeenCalledWith('[12:00:00 AM] message with time\n');
   });
 });

packages/codegen/src/logger/logger.ts

@@ -2,12 +2,12 @@ import { inspect } from 'node:util';
 import type { DiagnosticSourceFile } from '@css-modules-kit/core';
 import { convertDiagnostic, convertSystemError, type Diagnostic, SystemError } from '@css-modules-kit/core';
 import ts from 'typescript';
-import { formatDiagnostics } from './formatter.js';
+import { formatDiagnostics, formatTime } from './formatter.js';
 
 export interface Logger {
   logDiagnostics(diagnostics: Diagnostic[]): void;
   logError(error: unknown): void;
-  logMessage(message: string): void;
+  logMessage(message: string, options?: { time?: boolean }): void;
   clearScreen(): void;
 }
 
@@ -43,8 +43,9 @@ export function createLogger(cwd: string, pretty: boolean): Logger {
         process.stderr.write(`${inspect(error, { colors: pretty })}\n`);
       }
     },
-    logMessage(message: string): void {
-      process.stdout.write(`${message}\n`);
+    logMessage(message: string, options?: { time?: boolean }): void {
+      const header = options?.time ? `${formatTime(new Date(), pretty)} ` : '';
+      process.stdout.write(`${header}${message}\n`);
     },
     clearScreen(): void {
       process.stdout.write('\x1B[2J\x1B[3J\x1B[H');