feat: add the possibility to choose to write a log file

Author: iamzjohn

docs/api/config.md

@@ -36,6 +36,7 @@ The configuration follows the `ClarityConfig` interface, which includes:
 | `logDirectory` | `string` | `'<project_root>/logs'` | Directory where logs are stored |
 | `rotation` | `boolean` \| `RotationConfig` | See below | Log rotation settings |
 | `verbose` | `boolean` | `false` | Whether to enable verbose output |
+| `writeToFile` | `boolean` | `false` | If `true`, logs are written to disk. If `false`, logs are console-only |
 
 ### Default Rotation Configuration
 

src/config.ts

@@ -1,7 +1,7 @@
 import type { ClarityConfig } from './types'
 import { join, relative, resolve } from 'node:path'
 import process from 'node:process'
-import { loadConfig as bunfigLoadConfig } from 'bunfig'
+import { tryLoadConfig as bunfigLoadConfig } from 'bunfig'
 
 // Get project root directory (where the package.json is located)
 function getProjectRoot(filePath?: string, options: { relative?: boolean } = {}): string {
@@ -42,22 +42,21 @@ export const defaultConfig: ClarityConfig = {
     encrypt: false,
   },
   verbose: false,
+  writeToFile: false,
 }
 
 // Load config with error handling
 async function loadConfig(): Promise<ClarityConfig> {
   try {
     // const isVerbose = process.env.CLARITY_VERBOSE === 'true' || defaultConfig.verbose
 
-    const loadedConfig = await bunfigLoadConfig({
-      name: 'clarity',
+    // bunfig.tryLoadConfig expects (name, options)
+    const loadedConfig = await bunfigLoadConfig('clarity', {
       defaultConfig,
       cwd: process.cwd(),
-      endpoint: '',
-      headers: {},
-    })
+    }) as Partial<ClarityConfig> | undefined
 
-    return { ...defaultConfig, ...loadedConfig }
+    return { ...defaultConfig, ...(loadedConfig || {}) }
   }
   catch {
     // If anything fails, return default config

src/logger.ts

@@ -142,6 +142,21 @@ export class Logger {
     }
   }
 
+  private shouldActivateFingersCrossed(level: LogLevel): boolean {
+    if (!this.fingersCrossedConfig)
+      return false
+
+    const levels: Record<LogLevel, number> = {
+      debug: 0,
+      info: 1,
+      success: 2,
+      warning: 3,
+      error: 4,
+    }
+    const activation = this.fingersCrossedConfig.activationLevel ?? 'error'
+    return levels[level] >= levels[activation]
+  }
+
   private initializeFingersCrossedConfig(options: Partial<ExtendedLoggerOptions>): FingersCrossedConfig | null {
     if (!options.fingersCrossedEnabled && options.fingersCrossed) {
       return {
@@ -193,6 +208,10 @@ export class Logger {
     return mergedOptions
   }
 
+  private shouldWriteToFile(): boolean {
+    return !isBrowserProcess() && this.config.writeToFile === true
+  }
+
   private async writeToFile(data: string): Promise<void> {
     // Create a flag to track if this operation has been cancelled
     const cancelled = false
@@ -380,6 +399,9 @@ export class Logger {
   setupRotation(): void {
     if (isBrowserProcess())
       return
+    // Skip rotation entirely when file writing is disabled
+    if (!this.shouldWriteToFile())
+      return
     if (typeof this.config.rotation === 'boolean')
       return
 
@@ -545,6 +567,8 @@ export class Logger {
   private async rotateLog(): Promise<void> {
     if (isBrowserProcess())
       return
+    if (!this.shouldWriteToFile())
+      return
 
     const stats = await stat(this.currentLogFile).catch(() => null)
     if (!stats)
@@ -657,10 +681,11 @@ export class Logger {
     if (this.shouldActivateFingersCrossed(level) && !this.isActivated) {
       this.isActivated = true
 
-      // Write all buffered entries
+      // Write all buffered entries (to file only when enabled)
       for (const entry of this.logBuffer) {
         const formattedBufferedEntry = await this.formatter.format(entry)
-        await this.writeToFile(formattedBufferedEntry)
+        if (this.shouldWriteToFile())
+          await this.writeToFile(formattedBufferedEntry)
         // eslint-disable-next-line no-console
         console.log(formattedBufferedEntry)
       }
@@ -672,41 +697,11 @@ export class Logger {
 
     if (this.isActivated) {
       // Direct write when activated
-      await this.writeToFile(formattedEntry)
+      if (this.shouldWriteToFile())
+        await this.writeToFile(formattedEntry)
       // eslint-disable-next-line no-console
       console.log(formattedEntry)
     }
-    else {
-      // Buffer the entry
-      if (this.logBuffer.length >= this.fingersCrossedConfig.bufferSize)
-        this.logBuffer.shift() // Remove oldest entry
-
-      const entry: LogEntry = {
-        timestamp: new Date(),
-        level,
-        message: formattedEntry,
-        name: this.name,
-      }
-      this.logBuffer.push(entry)
-    }
-  }
-
-  private shouldActivateFingersCrossed(level: LogLevel): boolean {
-    if (!this.fingersCrossedConfig)
-      return false
-
-    return this.getLevelValue(level) >= this.getLevelValue(this.fingersCrossedConfig.activationLevel)
-  }
-
-  private getLevelValue(level: LogLevel): number {
-    const levels: Record<LogLevel, number> = {
-      debug: 0,
-      info: 1,
-      success: 2,
-      warning: 3,
-      error: 4,
-    }
-    return levels[level]
   }
 
   private shouldLog(level: LogLevel): boolean {
@@ -1028,8 +1023,9 @@ export class Logger {
     }
     logEntry = logEntry.replace(this.ANSI_PATTERN, '')
 
-    // Write to file
-    await this.writeToFile(logEntry)
+    // Write to file only when enabled
+    if (this.shouldWriteToFile())
+      await this.writeToFile(logEntry)
   }
 
   /**
@@ -1090,7 +1086,8 @@ export class Logger {
       }
 
       // Write directly to file instead of using this.info()
-      await this.writeToFile(logEntry)
+      if (this.shouldWriteToFile())
+        await this.writeToFile(logEntry)
     }
   }
 
@@ -1360,7 +1357,8 @@ export class Logger {
 
     // Write directly to file instead of using this.info()
     const logEntry = `${fileTime} ${this.environment}.INFO: [BOX] ${message}\n`.replace(this.ANSI_PATTERN, '')
-    await this.writeToFile(logEntry)
+    if (this.shouldWriteToFile())
+      await this.writeToFile(logEntry)
   }
 
   /**

src/types.ts

@@ -115,6 +115,12 @@ export interface ClarityConfig {
    * @default false
    */
   verbose: boolean
+
+  /**
+   * Write logs to file system in addition to console output
+   * @default false
+   */
+  writeToFile?: boolean
 }
 
 export type ClarityOptions = Partial<ClarityConfig>
@@ -130,6 +136,10 @@ export interface LoggerOptions {
   format?: 'json' | 'text'
   rotation?: RotationConfig
   timestamp?: string | number | Date
+  /**
+   * When true, logs are written to files; when false, logs are console-only
+   */
+  writeToFile?: boolean
   fingersCrossed?: boolean | {
     activationLevel?: LogLevel
     bufferSize?: number