feat: add configurable logger with quiet mode and ignoreLogs support

Author: hitarth-gg

src/index.ts

@@ -4,11 +4,13 @@ import { createRequire } from 'node:module';
 import type {
   Channel,
   Direction,
+  InstallOptions,
   IpcEventData,
   IpcEventDataIndexed,
   ServiceWorkerDetails,
 } from './types/shared';
 import { excludedIpcChannels } from './common/constants';
+import { logger } from './utils/Logger';
 
 interface TrackIpcEventOptions {
   direction: Direction;
@@ -65,7 +67,7 @@ function trackIpcEvent({
   if (excludedIpcChannels.includes(channel)) return;
 
   if (!devtronSW) {
-    console.error('The service-worker for Devtron is not registered yet. Cannot track IPC event.');
+    logger.warn('The service-worker for Devtron is not registered yet. Cannot track IPC event.');
     return;
   }
 
@@ -208,7 +210,7 @@ async function startServiceWorker(ses: Electron.Session, extension: Electron.Ext
     registerIpcListeners(ses, sw);
     registerServiceWorkerSendListener(ses, sw);
   } catch (error) {
-    console.warn(`Failed to start Devtron service-worker (${error}), trying again...`);
+    logger.warn(`Failed to start Devtron service-worker (${error}), trying again...`);
     /**
      * This is a workaround for the issue where the Devtron service-worker fails to start
      * when the Electron app is launched for the first time, or when the service worker
@@ -226,12 +228,12 @@ async function startServiceWorker(ses: Electron.Session, extension: Electron.Ext
           registerIpcListeners(ses, sw);
           registerServiceWorkerSendListener(ses, sw);
           ses.serviceWorkers.removeListener('registration-completed', handleDetails);
-          console.log(`Devtron service-worker started successfully`);
+          logger.info(`Devtron service-worker started successfully`);
         }
       };
       ses.serviceWorkers.on('registration-completed', handleDetails);
     } catch (error) {
-      console.error('Failed to start Devtron service-worker:', error);
+      logger.error('Failed to start Devtron service-worker:', error);
     }
   }
 }
@@ -373,10 +375,14 @@ function patchIpcMain() {
   };
 }
 
-async function install() {
+async function install(options: InstallOptions = {}) {
   if (isInstalled) return;
   isInstalled = true;
 
+  // set logger options
+  if (options.quiet) logger.setQuiet(true);
+  if (options.ignoreLogs) logger.setIgnoreLogs(options.ignoreLogs); // overrides `quiet` option
+
   patchIpcMain();
 
   const installToSession = async (ses: Electron.Session) => {
@@ -410,9 +416,9 @@ async function install() {
       const extensionPath = path.resolve(serviceWorkerPreloadPath, '..', '..', 'extension');
       devtron = await ses.extensions.loadExtension(extensionPath, { allowFileAccess: true });
       await startServiceWorker(ses, devtron);
-      console.log('Devtron loaded successfully');
+      logger.info('Devtron loaded successfully');
     } catch (error) {
-      console.error('Failed to load Devtron:', error);
+      logger.error('Failed to load Devtron:', error);
     }
   };
 
@@ -430,12 +436,12 @@ async function install() {
  */
 async function getEvents(): Promise<IpcEventDataIndexed[]> {
   if (!isInstalled) {
-    console.warn('You are trying to get IPC events before Devtron is installed.');
+    logger.warn('You are trying to get IPC events before Devtron is installed.');
     return [];
   }
 
   if (!devtronSW) {
-    console.warn('Devtron service-worker is not registered yet. Cannot get IPC events.');
+    logger.warn('Devtron service-worker is not registered yet. Cannot get IPC events.');
     return [];
   }
 

src/types/shared.ts

@@ -27,6 +27,30 @@ export interface IpcEventData {
   uuid?: UUID; // UUID to match requests and responses (for `invoke` and `sendSync` methods on `ipcRenderer`)
 }
 
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+
+export interface InstallOptions {
+  /**
+   * Suppresses all logs except 'error' level logs from
+   * appearing in the terminal.
+   *
+   * Precisely, it ignores 'debug', 'info', and 'warn' logs.
+   *
+   * @default false
+   */
+  quiet?: boolean;
+
+  /**
+   * List of log levels to ignore, e.g. ['debug', 'info'].
+   * Overrides the `quiet` option if both are set.
+   *
+   * Possible values for log levels are: 'debug', 'info', 'warn', 'error'
+   *
+   * @default [] (no log levels are ignored)
+   */
+  ignoreLogs?: LogLevel[];
+}
+
 /* ------------------------------------------------------ */
 
 /* ---------------------- EXTENSION --------------------- */

src/utils/Logger.ts

@@ -0,0 +1,61 @@
+import type { LogLevel } from '../types/shared';
+
+class Logger {
+  private quiet = false;
+  private ignoreLogs: Set<LogLevel> = new Set();
+
+  setQuiet(value: boolean) {
+    if (this.quiet === value) return; // no change
+
+    this.quiet = value;
+
+    // if quiet is true, ignore all logs except 'error'
+    if (this.quiet) {
+      this.ignoreLogs.add('debug');
+      this.ignoreLogs.add('info');
+      this.ignoreLogs.add('warn');
+    } else {
+      this.ignoreLogs.delete('debug');
+      this.ignoreLogs.delete('info');
+      this.ignoreLogs.delete('warn');
+    }
+  }
+
+  setIgnoreLogs(levels: LogLevel[]) {
+    this.ignoreLogs = new Set(levels);
+  }
+
+  private log(level: LogLevel, ...args: any[]) {
+    if (this.ignoreLogs.has(level)) return;
+
+    switch (level) {
+      case 'debug':
+        console.debug(...args);
+        break;
+      case 'info':
+        console.log(...args);
+        break;
+      case 'warn':
+        console.warn(...args);
+        break;
+      case 'error':
+        console.error(...args);
+        break;
+    }
+  }
+
+  debug(...args: any[]) {
+    this.log('debug', ...args);
+  }
+  info(...args: any[]) {
+    this.log('info', ...args);
+  }
+  warn(...args: any[]) {
+    this.log('warn', ...args);
+  }
+  error(...args: any[]) {
+    this.log('error', ...args);
+  }
+}
+
+export const logger = new Logger();