Skip to content

Commit 97eb8fb

Browse files
author
Kevin Beier
committed
more log functions and fixes
1 parent 290d51d commit 97eb8fb

4 files changed

Lines changed: 78 additions & 23 deletions

File tree

electron/preload/index.ts

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,20 +114,24 @@ contextBridge.exposeInMainWorld('electronAPI', {
114114
},
115115
saveLog: (
116116
message: string,
117-
level: ElectronLogLevel = ElectronLogLevel.info
117+
level: ElectronLogLevel = ElectronLogLevel.INFO,
118+
logFile = 'vigad.log'
118119
) => {
119-
log[level](message); // Save log message using electron-log
120+
// Set the desired log file name
121+
log.transports.file.fileName = logFile;
122+
// Save log message using electron-log
123+
log[level](message);
120124
},
121125
});
122126

123127
/**
124128
* Electron log levels enum declaration
125129
*/
126-
enum ElectronLogLevel {
127-
error = 'error',
128-
warn = 'warn',
129-
info = 'info',
130-
verbose = 'verbose',
131-
debug = 'debug',
132-
silly = 'silly',
130+
export enum ElectronLogLevel {
131+
INFO = 'info',
132+
WARN = 'warn',
133+
ERROR = 'error',
134+
VERBOSE = 'verbose',
135+
DEBUG = 'debug',
136+
SILLY = 'silly',
133137
}

src/components/Navigation/BottomNavigation.vue

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,6 @@
3434
<script setup lang="ts">
3535
import useRunning from '@/composables/useRunning/useRunning';
3636
import SettingsPrompt from '@/components/SettingsPrompt/SettingsPrompt.vue';
37-
import useLogger from '@/composables/useLogger/useLogger';
38-
39-
const { addLog } = useLogger();
4037
4138
// Use the useRunning composable to get the isRunning state
4239
const { isRunning } = useRunning();

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
* Electron log levels enum
33
*/
44
export enum ElectronLogLevel {
5-
error = 'error',
6-
warn = 'warn',
7-
info = 'info',
8-
verbose = 'verbose',
9-
debug = 'debug',
10-
silly = 'silly',
5+
INFO = 'info',
6+
WARN = 'warn',
7+
ERROR = 'error',
8+
VERBOSE = 'verbose',
9+
DEBUG = 'debug',
10+
SILLY = 'silly',
1111
}

src/composables/useLogger/useLogger.ts

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ import { ElectronLogLevel } from './electron-log-level';
44

55
/**
66
* Create a logger instance
7+
* @type {Logger}
78
*/
89
const logger = new Logger();
910

1011
/**
11-
* Referene to the electron logger in the main process
12+
* Reference to the electron logger in the main process
13+
* @type {any}
1214
*/
1315
const electronLogger = (window as any).electronAPI;
1416

@@ -18,11 +20,55 @@ const electronLogger = (window as any).electronAPI;
1820
export default function useLogger() {
1921
const logMessages = ref<string[]>([]);
2022

21-
// Function to add log messages
22-
const addLog = (message: string) => {
23+
/**
24+
* Function to add log messages
25+
* @param {string} message - The log message
26+
* @param {ElectronLogLevel} [logLevel=ElectronLogLevel.INFO] - The log level
27+
*/
28+
const addLog = (message: string, logLevel = ElectronLogLevel.INFO) => {
2329
logger.debug(message);
2430
logMessages.value.push(message);
25-
electronLogger.saveLog(message, ElectronLogLevel.debug);
31+
electronLogger.saveLog(message, logLevel);
32+
};
33+
34+
/**
35+
* Function to add warning log messages
36+
* @param {string} message - The log message
37+
*/
38+
const addWarnLog = (message: string) => {
39+
addLog(message, ElectronLogLevel.WARN);
40+
};
41+
42+
/**
43+
* Function to add error log messages
44+
* @param {string} message - The log message
45+
*/
46+
const addErrorLog = (message: string) => {
47+
addLog(message, ElectronLogLevel.ERROR);
48+
};
49+
50+
/**
51+
* Function to add verbose log messages
52+
* @param {string} message - The log message
53+
*/
54+
const addVerboseLog = (message: string) => {
55+
addLog(message, ElectronLogLevel.VERBOSE);
56+
};
57+
58+
/**
59+
* Function to add debug log messages
60+
* @param {string} message - The log message
61+
*/
62+
const addDebugLog = (message: string) => {
63+
addLog(message, ElectronLogLevel.DEBUG);
64+
};
65+
66+
/**
67+
* Function to add silly log messages
68+
* @param {string} message - The log message
69+
*/
70+
const addSillyLog = (message: string) => {
71+
addLog(message, ElectronLogLevel.SILLY);
2672
};
2773

2874
// Lifecycle hooks
@@ -34,5 +80,13 @@ export default function useLogger() {
3480
logger.info('Logger terminated');
3581
});
3682

37-
return { log: logMessages, addLog };
83+
return {
84+
log: logMessages,
85+
addLog,
86+
addErrorLog,
87+
addWarnLog,
88+
addVerboseLog,
89+
addDebugLog,
90+
addSillyLog,
91+
};
3892
}

0 commit comments

Comments
 (0)