feat: logger

electron/preload/index.ts

@@ -1,3 +1,5 @@
+import log from 'electron-log';
+
 function domReady(
     condition: DocumentReadyState[] = ['complete', 'interactive']
 ) {
@@ -110,4 +112,26 @@ contextBridge.exposeInMainWorld('electronAPI', {
                 });
         });
     },
+    saveLog: (
+        message: string,
+        level: ElectronLogLevel = ElectronLogLevel.INFO,
+        logFile = 'vigad.log'
+    ) => {
+        // Set the desired log file name
+        log.transports.file.fileName = logFile;
+        // Save log message using electron-log
+        log[level](message);
+    },
 });
+
+/**
+ * Electron log levels enum declaration
+ */
+export enum ElectronLogLevel {
+    INFO = 'info',
+    WARN = 'warn',
+    ERROR = 'error',
+    VERBOSE = 'verbose',
+    DEBUG = 'debug',
+    SILLY = 'silly',
+}

package.json

@@ -72,10 +72,12 @@
         "@vueuse/components": "^10.1.2",
         "@vueuse/core": "^10.1.2",
         "clipboardy": "^3.0.0",
+        "electron-log": "^4.4.8",
         "randexp": "^0.5.3",
         "roboto-fontface": "^0.10.0",
         "tesseract.js": "^3.0.3",
         "tplant": "^3.1.0",
+        "tslog": "^4.8.2",
         "vue-router": "^4.2.2",
         "vue3-drag-resize": "^2.0.5",
         "vuetify": "^3.3.2"

src/composables/useLogger/electron-log-level.ts

@@ -0,0 +1,11 @@
+/**
+ * Electron log levels enum
+ */
+export enum ElectronLogLevel {
+    INFO = 'info',
+    WARN = 'warn',
+    ERROR = 'error',
+    VERBOSE = 'verbose',
+    DEBUG = 'debug',
+    SILLY = 'silly',
+}

src/composables/useLogger/useLogger.ts

@@ -0,0 +1,92 @@
+import { onMounted, onUnmounted, ref } from 'vue';
+import { Logger } from 'tslog';
+import { ElectronLogLevel } from './electron-log-level';
+
+/**
+ * Create a logger instance
+ * @type {Logger}
+ */
+const logger = new Logger();
+
+/**
+ * Reference to the electron logger in the main process
+ * @type {any}
+ */
+const electronLogger = (window as any).electronAPI;
+
+/**
+ * Logger composable
+ */
+export default function useLogger() {
+    const logMessages = ref<string[]>([]);
+
+    /**
+     * Function to add log messages
+     * @param {string} message - The log message
+     * @param {ElectronLogLevel} [logLevel=ElectronLogLevel.INFO] - The log level
+     */
+    const addLog = (message: string, logLevel = ElectronLogLevel.INFO) => {
+        logger.debug(message);
+        logMessages.value.push(message);
+        electronLogger.saveLog(message, logLevel);
+    };
+
+    /**
+     * Function to add warning log messages
+     * @param {string} message - The log message
+     */
+    const addWarnLog = (message: string) => {
+        addLog(message, ElectronLogLevel.WARN);
+    };
+
+    /**
+     * Function to add error log messages
+     * @param {string} message - The log message
+     */
+    const addErrorLog = (message: string) => {
+        addLog(message, ElectronLogLevel.ERROR);
+    };
+
+    /**
+     * Function to add verbose log messages
+     * @param {string} message - The log message
+     */
+    const addVerboseLog = (message: string) => {
+        addLog(message, ElectronLogLevel.VERBOSE);
+    };
+
+    /**
+     * Function to add debug log messages
+     * @param {string} message - The log message
+     */
+    const addDebugLog = (message: string) => {
+        addLog(message, ElectronLogLevel.DEBUG);
+    };
+
+    /**
+     * Function to add silly log messages
+     * @param {string} message - The log message
+     */
+    const addSillyLog = (message: string) => {
+        addLog(message, ElectronLogLevel.SILLY);
+    };
+
+    // Lifecycle hooks
+    onMounted(() => {
+        logger.info('Logger initialized');
+    });
+
+    onUnmounted(() => {
+        logger.info('Logger terminated');
+    });
+
+    return {
+        log: logMessages,
+        addLog,
+        addErrorLog,
+        addWarnLog,
+        addVerboseLog,
+        addDebugLog,
+        addSillyLog,
+    };
+}