feat(logger): Implement configurable and colorful logging

This commit introduces a new logging utility to the microstream-client SDK, allowing developers to control the verbosity of logs using a configurable logLevel option. The logLevel supports the following levels: "debug", "info", "warn", "error", and "silent". Additionally, logs are now color-coded based on their type for better readability.

Changes include:
- Creation of a logger.ts file in src/utils/ with methods for debug, info, warn, and error, respecting the logLevel setting.
- Addition of a logLevel option to the MicrostreamClientOptions interface.
- Initialization of the logger in the MicrostreamClient constructor using the provided logLevel.
- Replacement of all console.log, console.warn, and console.error calls with the appropriate logger methods.
- Color-coding of log messages using the chalk library.

Author: arijitcodes

bun.lockb

@@ -32,6 +32,7 @@
   "author": "Arijit Banerjee <[email protected]>",
   "license": "MIT",
   "dependencies": {
+    "chalk": "^4.1.2",
     "nanoid": "^4.0.0",
     "socket.io-client": "^4.5.0"
   },
@@ -40,4 +41,4 @@
     "jest": "^29.0.0",
     "typescript": "^5.7.3"
   }
-}
+}

package-lock.json

@@ -189,7 +189,7 @@ export class MicrostreamClient {
         `[${this.serviceName}] Starting heartbeat with interval ${this.heartbeatInterval}ms`
       );
       this.heartbeatTimer = setInterval(() => {
-        this.logger.debug(`[${this.serviceName}] Sending heartbeat}`);
+        this.logger.debug(`[${this.serviceName}] Sending heartbeat`);
         this.socket.emit("heartbeat", { serviceName: this.serviceName });
       }, this.heartbeatInterval);
     }

package.json

@@ -1,3 +1,5 @@
+import chalk from "chalk";
+
 export type LogLevel = "debug" | "info" | "warn" | "error" | "silent";
 
 export default class Logger {
@@ -12,11 +14,34 @@ export default class Logger {
     return levels.indexOf(level) >= levels.indexOf(this.logLevel);
   }
 
-  private formatMessage(level: string, ...args: any[]): string {
-    const timestamp = new Date().toISOString();
-    return `[MicroStream Client][${timestamp}][${level.toUpperCase()}] ${args.join(
-      " "
-    )}`;
+  private formatMessage(level: LogLevel, ...args: any[]): string {
+    if (level === "silent") {
+      return ""; // Skip formatting for "silent" logs
+    }
+
+    const prefix = chalk.magenta(`[MicroStream Client]`);
+    const timestamp = chalk.gray(`[${new Date().toISOString()}]`);
+
+    // Define levelLabel with a default value
+    const levelLabel =
+      {
+        debug: chalk.greenBright,
+        info: chalk.cyan,
+        warn: chalk.yellow,
+        error: chalk.red,
+      }[level] || chalk.white; // Default to white if level is invalid
+
+    const formattedLevel = levelLabel(`[${level.toUpperCase()}]`);
+    const message = args
+      .map((arg) =>
+        arg instanceof Error
+          ? arg.stack
+          : typeof arg === "object"
+          ? JSON.stringify(arg, null, 2)
+          : arg
+      )
+      .join(" ");
+    return `${prefix}${timestamp}${formattedLevel} ${message}`;
   }
 
   debug(...args: any[]) {