Log internal errors with logger (#275)

* feat: log internal errors with logger

* add changelog

Author: mizdra

.changeset/busy-snails-play.md

@@ -0,0 +1,5 @@
+---
+'@css-modules-kit/codegen': patch
+---
+
+feat: log internal errors with logger

packages/codegen/bin/cmk.mjs

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 /* eslint-disable n/no-process-exit */
 
-import { SystemError } from '@css-modules-kit/core';
 import { createLogger, parseCLIArgs, printHelpText, printVersion, runCMK, shouldBePretty } from '../dist/index.js';
 
 const cwd = process.cwd();
@@ -21,9 +20,6 @@ try {
 
   await runCMK(args, logger);
 } catch (e) {
-  if (e instanceof SystemError) {
-    logger.logSystemError(e);
-    process.exit(1);
-  }
-  throw e;
+  logger.logError(e);
+  process.exit(1);
 }

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

@@ -34,22 +34,25 @@ describe('createLogger', () => {
       "
     `);
   });
-  test('logSystemError', () => {
+  test('logError', () => {
     const logger = createLogger(cwd, false);
-    logger.logSystemError(new SystemError('CODE', 'message'));
+    logger.logError(new SystemError('CODE', 'message'));
     expect(stripVTControlCharacters(stderrWriteSpy.mock.lastCall![0] as string)).toMatchInlineSnapshot(`
       "error: message
 
       "
     `);
-    logger.logSystemError(
-      new ReadCSSModuleFileError('/app/a.module.css', new Error('EACCES: permission denied, open ...')),
-    );
+    logger.logError(new ReadCSSModuleFileError('/app/a.module.css', new Error('EACCES: permission denied, open ...')));
     expect(stripVTControlCharacters(stderrWriteSpy.mock.lastCall![0] as string)).toMatchInlineSnapshot(`
       "error: Failed to read CSS Module file /app/a.module.css.: EACCES: permission denied, open ...
 
       "
     `);
+    logger.logError(new Error('Some unknown error'));
+    // Check that error message and stack trace are included
+    expect(stripVTControlCharacters(stderrWriteSpy.mock.lastCall![0] as string)).toMatch(
+      /^Error: Some unknown error\n {4}at /mu,
+    );
   });
   test('logMessage', () => {
     const logger = createLogger(cwd, false);

packages/codegen/src/logger/logger.ts

@@ -1,11 +1,12 @@
+import { inspect } from 'node:util';
 import type { DiagnosticSourceFile } from '@css-modules-kit/core';
-import { convertDiagnostic, convertSystemError, type Diagnostic, type SystemError } 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';
 
 export interface Logger {
   logDiagnostics(diagnostics: Diagnostic[]): void;
-  logSystemError(error: SystemError): void;
+  logError(error: unknown): void;
   logMessage(message: string): void;
 }
 
@@ -29,9 +30,17 @@ export function createLogger(cwd: string, pretty: boolean): Logger {
       );
       process.stderr.write(result);
     },
-    logSystemError(error: SystemError): void {
-      const result = formatDiagnostics([convertSystemError(error)], host, pretty);
-      process.stderr.write(result);
+    logError(error: unknown): void {
+      // NOTE: SystemErrors are errors expected by the css-modules-kit specification and may occur within normal usage.
+      // These errors are formatted clearly and concisely. No stack trace is output.
+      //
+      // All other errors are unexpected errors. To assist in debugging when these errors occur, a stack trace is output.
+      if (error instanceof SystemError) {
+        const result = formatDiagnostics([convertSystemError(error)], host, pretty);
+        process.stderr.write(result);
+      } else {
+        process.stderr.write(`${inspect(error, { colors: pretty })}\n`);
+      }
     },
     logMessage(message: string): void {
       process.stdout.write(`${message}\n`);

packages/codegen/src/test/logger.ts

@@ -4,7 +4,7 @@ import type { Logger } from '../logger/logger.js';
 export function createLoggerSpy() {
   return {
     logDiagnostics: vi.fn(),
-    logSystemError: vi.fn(),
+    logError: vi.fn(),
     logMessage: vi.fn(),
   } satisfies Logger;
 }