feat: add configurable logLevel to install options (#283)

* feat: add configurable logger with `quiet` mode and `ignoreLogs` support

* docs: update README.md

* fix: types

* docs: add examples for install options

* chore: use `logLevel` instead

* docs: update `install` options in README.md

* docs: minor change

* chore: use enums

---------

Co-authored-by: David Sanders <[email protected]>

Author: hitarth-gg

README.md

@@ -44,10 +44,23 @@ if (isDev) {
 
 ## Devtron API
 
-### `await devtron.install()`
+### `await devtron.install(options)`
 
 Installs Devtron into the Electron app. Refer to [Configuring an Electron App to use Devtron](#configuring-an-electron-app-to-use-devtron) for installation instructions.
 
+#### `Options`
+
+| Option     | Type                                               | Default   | Description                                                                                                                                                                                                                                                                                        |
+| ---------- | -------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `logLevel` | `'debug' \| 'info' \| 'warn' \| 'error' \| 'none'` | `'debug'` | Sets the minimum log level for the logger. Messages below this level are ignored. <br><br> **Levels:** <br>• `debug` — logs: debug, info, warn, error <br>• `info` — logs: info, warn, error <br>• `warn` — logs: warn, error <br>• `error` — logs: error only <br>• `none` — disables all logging |
+
+Examples:
+
+```js
+// Only 'warn' and 'error' logs will appear in the terminal
+await devtron.install({ logLevel: 'warn' });
+```
+
 ### `await devtron.getEvents()`
 
 Returns a **promise** that resolves to the array of IPC events recorded by the Devtron service worker since installation.

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,13 @@ function patchIpcMain() {
   };
 }
 
-async function install() {
+async function install(options: InstallOptions = {}) {
   if (isInstalled) return;
   isInstalled = true;
 
+  // set log level
+  if (options.logLevel) logger.setLogLevel(options.logLevel);
+
   patchIpcMain();
 
   const installToSession = async (ses: Electron.Session) => {
@@ -410,9 +415,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 +435,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,33 @@ export interface IpcEventData {
   uuid?: UUID; // UUID to match requests and responses (for `invoke` and `sendSync` methods on `ipcRenderer`)
 }
 
+export type LogLevelString = 'debug' | 'info' | 'warn' | 'error' | 'none';
+
+export enum LogLevel {
+  debug,
+  info,
+  warn,
+  error,
+  none,
+}
+
+export interface InstallOptions {
+  /**
+   * Sets the minimum log level for the logger.
+   * All messages below the specified level will be ignored.
+   *
+   * Available levels:
+   * - 'debug' — logs: debug, info, warn, error
+   * - 'info'  — logs: info, warn, error
+   * - 'warn'  — logs: warn, error
+   * - 'error' — logs: error only
+   * - 'none'  — disables all logging
+   *
+   * @default 'debug'
+   */
+  logLevel?: LogLevelString;
+}
+
 /* ------------------------------------------------------ */
 
 /* ---------------------- EXTENSION --------------------- */

src/utils/Logger.ts

@@ -0,0 +1,52 @@
+import type { LogLevelString } from '../types/shared';
+import { LogLevel } from '../types/shared';
+
+class Logger {
+  private currentLogLevel = LogLevel.debug;
+
+  setLogLevel(level: LogLevelString) {
+    if (LogLevel[level] === undefined) {
+      console.error(`Invalid log level: ${level}`);
+      return;
+    }
+
+    if (LogLevel[level] === this.currentLogLevel) return; // no change
+
+    this.currentLogLevel = LogLevel[level];
+  }
+
+  private log(level: LogLevel, ...args: any[]) {
+    if (this.currentLogLevel === LogLevel.none) return;
+    if (level < this.currentLogLevel) return;
+
+    switch (level) {
+      case LogLevel.debug:
+        console.debug(...args);
+        break;
+      case LogLevel.info:
+        console.log(...args);
+        break;
+      case LogLevel.warn:
+        console.warn(...args);
+        break;
+      case LogLevel.error:
+        console.error(...args);
+        break;
+    }
+  }
+
+  debug(...args: any[]) {
+    this.log(LogLevel.debug, ...args);
+  }
+  info(...args: any[]) {
+    this.log(LogLevel.info, ...args);
+  }
+  warn(...args: any[]) {
+    this.log(LogLevel.warn, ...args);
+  }
+  error(...args: any[]) {
+    this.log(LogLevel.error, ...args);
+  }
+}
+
+export const logger = new Logger();