Stringify non-string logging

mattwebbio · Oct 1, 2022 · 21737a9 · 21737a9
1 parent 6cd5a32
commit 21737a9
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/src/log.test.ts b/src/log.test.ts
@@ -10,6 +10,7 @@ describe('Log', () => {
 
   afterEach(() => {
     jest.resetModules();
+    jest.restoreAllMocks();
   });
 
   afterAll(() => {
@@ -27,6 +28,18 @@ describe('Log', () => {
         `${chalk.dim('8/27/2022, 8:17:31 AM')}: Hello world`
       );
     });
+
+    test('should log stringified', () => {
+      const consoleLog = jest.spyOn(console, 'log');
+
+      Log.info({ foo: 'bar' });
+
+      expect(consoleLog).toHaveBeenCalledTimes(1);
+      expect(consoleLog).toHaveBeenCalledWith(
+        // eslint-disable-next-line no-useless-escape
+        `${chalk.dim('8/27/2022, 8:17:31 AM')}: {\"foo\":\"bar\"}`
+      );
+    });
   });
 
   describe('verbose', () => {

diff --git a/src/log.ts b/src/log.ts
@@ -3,15 +3,20 @@ import { Config } from './config.js';
 
 export class Log {
   static info(message: unknown) {
-    console.log(`${this.timestamp}: ${message}`);
+    console.log(`${this.timestamp}: ${this.stringify(message)}`);
   }
 
   static verbose(message: unknown) {
-    if (Config.verboseMode && message) this.info(message);
+    if (Config.verboseMode && message) this.info(this.stringify(message));
   }
 
   static error(message: unknown) {
-    console.error(`${this.timestamp}: ${chalk.red(message)}`);
+    console.error(`${this.timestamp}: ${chalk.red(this.stringify(message))}`);
+  }
+
+  private static stringify(message: unknown): string {
+    if (typeof message === 'string') return message;
+    else return JSON.stringify(message);
   }
 
   private static get timestamp(): string {