@ricdotnet/logger 0.0.11 → 0.2.0

package/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "semi": true,
+  "trailingComma": "all"
+}

package/Logs/28-12-2023-debug.log

@@ -0,0 +1,9 @@
+Log Time: 12:58
+hello world
+
+Log Time: 14:45
+hello world
+
+Log Time: 14:45
+Logs folder already exists. Logging to: Logs
+

package/Logs/28-12-2023-error.log

@@ -0,0 +1,3 @@
+Log Time: 14:45
+hello world
+

package/Logs/28-12-2023-info.log

@@ -0,0 +1,3 @@
+Log Time: 14:45
+hello world
+

package/Logs/28-12-2023-warn.log

@@ -0,0 +1,3 @@
+Log Time: 14:45
+hello world
+

package/Tests/Logger.spec.ts

@@ -1,55 +1,47 @@
 import { Logger } from '../src/Logger';
-import { Constants } from '../src/Constants';
 
-
-// const loggerSpy = {
-//   info: jest.spyOn(Logger.getInstance(), 'info'),
-//   warn: jest.spyOn(Logger.getInstance(), 'warn'),
-//   error: jest.spyOn(Logger.getInstance(), 'error')
-// };
-
-const consoleSpy = {
-  info: jest.spyOn(console, 'log'),
-  warn: jest.spyOn(console, 'warn'),
-  error: jest.spyOn(console, 'error'),
+const loggerSpy = {
+  debug: null,
+  info: null,
+  warn: null,
+  error: null,
 };
 
 describe('Logger test', () => {
-  let loggerInstance;
-  let loggerSpy;
+  beforeAll(() => {
+    new Logger();
 
-  beforeEach(() => {
-    loggerInstance = new Logger();
+    loggerSpy.debug = jest.spyOn(Logger.get(), 'debug');
+    loggerSpy.info = jest.spyOn(Logger.get(), 'info');
+    loggerSpy.warn = jest.spyOn(Logger.get(), 'warn');
+    loggerSpy.error = jest.spyOn(Logger.get(), 'error');
+  });
 
-    loggerSpy = {
-      info: jest.spyOn(loggerInstance, 'info'),
-      warn: jest.spyOn(loggerInstance, 'warn'),
-      error: jest.spyOn(loggerInstance, 'error')
-    };
+  it('can log a debug', async () => {
+    await Logger.get().debug('hello world');
 
-    loggerSpy.info.mockClear();
-    loggerSpy.warn.mockClear();
-    loggerSpy.error.mockClear();
+    expect(loggerSpy.debug).toHaveBeenCalledWith('hello world');
+    expect(loggerSpy.debug).toHaveBeenCalledTimes(1);
   });
 
   it('can log an info', async () => {
-    await loggerInstance.info('hello world');
+    await Logger.get().info('hello world');
 
-    await expect(loggerSpy.info).toHaveBeenCalledWith('hello world');
-    await expect(consoleSpy.info).toHaveBeenCalledWith(`${Constants.TEXT_BLUE}[INFO]: hello world`);
+    expect(loggerSpy.info).toHaveBeenCalledWith('hello world');
+    expect(loggerSpy.info).toHaveBeenCalledTimes(1);
   });
 
-  it('can log a warning', () => {
-    loggerInstance.warn('hello world');
+  it('can log a warning', async () => {
+    await Logger.get().warn('hello world');
 
     expect(loggerSpy.warn).toHaveBeenCalledWith('hello world');
-    // expect(consoleSpy.warn).toHaveBeenCalledWith(`${Constants.TEXT_YELLOW}[WARN]: hello world`);
+    expect(loggerSpy.warn).toHaveBeenCalledTimes(1);
   });
 
-  it('can log an error', () => {
-    loggerInstance.error('hello world');
+  it('can log an error', async () => {
+    await Logger.get().error('hello world');
 
     expect(loggerSpy.error).toHaveBeenCalledWith('hello world');
-    expect(consoleSpy.error).toHaveBeenCalledWith(`${Constants.TEXT_RED}[ERROR]: hello world`);
+    expect(loggerSpy.error).toHaveBeenCalledTimes(1);
   });
 });

package/Tests/WriteToFile.spec.ts

@@ -0,0 +1,43 @@
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import { Logger } from '../src/Logger';
+import {Queue} from "../src/Queue";
+
+const spy = {
+  writeToFile: null,
+}
+
+describe('Write to file test', () => {
+  beforeAll(() => {
+    new Logger({
+      logToFile: true,
+      logToConsole: false,
+    });
+
+    spy.writeToFile = jest.spyOn(Queue.prototype as any, 'writeToFile');
+  });
+
+  // afterAll(async () => {
+  //   await fs.rm(path.join(process.cwd(), 'Logs'), { recursive: true });
+  // });
+
+  it('can write a debug log to file', async () => {
+    await Logger.get().debug('hello world');
+    expect(spy.writeToFile).toHaveBeenCalledTimes(1);
+  });
+
+  it('can write an info log to file', async () => {
+    await Logger.get().info('hello world');
+    expect(spy.writeToFile).toHaveBeenCalledTimes(1);
+  });
+
+  it('can write a warn log to file', async () => {
+    await Logger.get().warn('hello world');
+    expect(spy.writeToFile).toHaveBeenCalledTimes(1);
+  });
+
+  it('can write an error log to file', async () => {
+    await Logger.get().error('hello world');
+    expect(spy.writeToFile).toHaveBeenCalledTimes(1);
+  });
+});

package/dist/src/Logger.d.ts

@@ -1,11 +1,15 @@
-import { ILogger, Primitives } from './Types';
+import { ILogger } from './Types';
 export declare class Logger {
     private readonly logDir;
     private readonly logToConsole;
+    private readonly logToFile;
+    private readonly level;
+    private static logger;
+    private readonly logQueue;
     constructor(options?: ILogger);
-    checkLogDir(): Promise<void>;
-    info<T = string>(message: T | Primitives): Promise<void>;
-    warn<T = string>(message: T | Primitives): Promise<void>;
-    error<T = string>(message: T | Primitives): Promise<void>;
-    writeToFile(message: any, type: string): Promise<void>;
+    static get(): Logger;
+    debug(message: string): Promise<void>;
+    info(message: string): Promise<void>;
+    warn(message: string): Promise<void>;
+    error(message: string): Promise<void>;
 }

package/dist/src/Logger.js

@@ -1,63 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
-const fs = require("fs/promises");
-const path = require("path");
 const Constants_1 = require("./Constants");
+const Queue_1 = require("./Queue");
 class Logger {
     logDir;
     logToConsole;
+    logToFile;
+    level;
+    static logger = null;
+    logQueue;
     constructor(options) {
-        this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
+        console.log('Initiating a logger...');
+        if (Logger.logger) {
+            console.warn('The logger was already initiated.');
+            return;
+        }
         this.logToConsole = options?.logToConsole ?? true;
-        this.checkLogDir();
+        this.logToFile = options?.logToFile ?? false;
+        this.level = options?.level ?? 'info';
+        Logger.logger = this;
+        if (this.logToFile) {
+            this.logQueue = new Queue_1.Queue(options);
+        }
+        console.log('Logger initiated.');
+    }
+    static get() {
+        return Logger.logger;
     }
-    async checkLogDir() {
-        try {
-            await fs.mkdir(this.logDir);
-            await this.info(`Logs folder generated. Logging to: ${this.logDir}`);
+    async debug(message) {
+        if (this.logToFile) {
+            this.logQueue.add(message, 'debug');
         }
-        catch (error) {
-            await this.info(`Logs folder already exists. Logging to: ${this.logDir}`);
+        if (this.logToConsole && this.level === 'debug') {
+            console.debug(`${Constants_1.Constants.TEXT_CYAN}[DEBUG]:${Constants_1.Constants.RESET} ${message}`);
         }
     }
     async info(message) {
-        await this.writeToFile(JSON.stringify(message), 'info');
+        if (this.logToFile) {
+            this.logQueue.add(message, 'info');
+        }
         if (this.logToConsole) {
-            console.log(`${Constants_1.Constants.TEXT_BLUE}[INFO]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
+            console.log(`${Constants_1.Constants.TEXT_BLUE}[INFO]:${Constants_1.Constants.RESET} ${message}`);
         }
     }
     async warn(message) {
-        await this.writeToFile(JSON.stringify(message), 'warn');
-        if (this.logToConsole) {
-            console.warn(`${Constants_1.Constants.TEXT_YELLOW}[WARN]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
+        if (this.logToFile) {
+            this.logQueue.add(message, 'warn');
         }
-    }
-    async error(message) {
-        await this.writeToFile(JSON.stringify(message), 'error');
         if (this.logToConsole) {
-            console.error(`${Constants_1.Constants.TEXT_RED}[ERROR]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
+            console.warn(`${Constants_1.Constants.TEXT_YELLOW}[WARN]:${Constants_1.Constants.RESET} ${message}`);
         }
     }
-    async writeToFile(message, type) {
-        const DAY = new Date().getDate();
-        const MONTH = new Date().getMonth() + 1;
-        const YEAR = new Date().getFullYear();
-        const HOURS = new Date().getHours();
-        const MINUTES = new Date().getMinutes();
-        const FULL_DATE = [DAY, MONTH, YEAR].join('-');
-        const FULL_TIME = [HOURS, MINUTES].join(':');
-        let logFile;
-        try {
-            logFile = await fs.readFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`));
-        }
-        catch (e) {
-            const data = 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
-            await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
+    async error(message) {
+        if (this.logToFile) {
+            this.logQueue.add(message, 'error');
         }
-        if (logFile) {
-            const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
-            await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
+        if (this.logToConsole) {
+            console.error(`${Constants_1.Constants.TEXT_RED}[ERROR]:${Constants_1.Constants.RESET} ${message}`);
         }
     }
 }

package/dist/src/Logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"Logger.js","sourceRoot":"./","sources":["src/Logger.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAClC,6BAA6B;AAC7B,2CAAwC;AAGxC,MAAa,MAAM;IAEA,MAAM,CAAS;IACf,YAAY,CAAU;IAEvC,YAAY,OAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,YAAY,IAAI,IAAI,CAAC;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,IAAI;YACF,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,MAAM,IAAI,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SACtE;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,CAAC,IAAI,CAAC,2CAA2C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SAC3E;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,GAAG,CAAC,GAAG,qBAAS,CAAC,SAAS,UAAU,qBAAS,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC3F;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,IAAI,CAAC,GAAG,qBAAS,CAAC,WAAW,UAAU,qBAAS,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC9F;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAa,OAAuB;QAC7C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACzD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,KAAK,CAAC,GAAG,qBAAS,CAAC,QAAQ,WAAW,qBAAS,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC7F;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAY,EAAE,IAAY;QAC1C,MAAM,GAAG,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACzC,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAChD,MAAM,IAAI,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAW,IAAI,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QAEhD,MAAM,SAAS,GAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,SAAS,GAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,OAAO,CAAC;QACZ,IAAI;YACF,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC;SACjF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;YAChE,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;SAC9E;QAED,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,GAAG,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;YAC1E,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;SAC9E;IACH,CAAC;CAEF;AAjED,wBAiEC"}
+{"version":3,"file":"Logger.js","sourceRoot":"./","sources":["src/Logger.ts"],"names":[],"mappings":";;;AACA,2CAAwC;AAExC,mCAAgC;AAEhC,MAAa,MAAM;IACA,MAAM,CAAS;IACf,YAAY,CAAU;IACtB,SAAS,CAAU;IACnB,KAAK,CAAW;IACzB,MAAM,CAAC,MAAM,GAAW,IAAI,CAAC;IAEpB,QAAQ,CAAQ;IAEjC,YAAY,OAAiB;QAC3B,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACtC,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YAClD,OAAO;SACR;QAED,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,YAAY,IAAI,IAAI,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,MAAM,CAAC;QAEtC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAK,CAAC,OAAO,CAAC,CAAC;SACpC;QAED,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,GAAG;QACR,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAe;QACzB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACrC;QACD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO,EAAE;YAC/C,OAAO,CAAC,KAAK,CACX,GAAG,qBAAS,CAAC,SAAS,WAAW,qBAAS,CAAC,KAAK,IAAI,OAAO,EAAE,CAC9D,CAAC;SACH;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAe;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,GAAG,CAAC,GAAG,qBAAS,CAAC,SAAS,UAAU,qBAAS,CAAC,KAAK,IAAI,OAAO,EAAE,CAAC,CAAC;SAC3E;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAe;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,IAAI,CACV,GAAG,qBAAS,CAAC,WAAW,UAAU,qBAAS,CAAC,KAAK,IAAI,OAAO,EAAE,CAC/D,CAAC;SACH;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAe;QACzB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACrC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,KAAK,CACX,GAAG,qBAAS,CAAC,QAAQ,WAAW,qBAAS,CAAC,KAAK,IAAI,OAAO,EAAE,CAC7D,CAAC;SACH;IACH,CAAC;;AAzEH,wBA0EC"}

package/dist/src/Queue.d.ts

@@ -0,0 +1,11 @@
+import { ILogger, LogLevel } from './Types';
+export declare class Queue {
+    private logQueue;
+    private isRunning;
+    private readonly logDir;
+    constructor(options: ILogger);
+    private checkLogDir;
+    add(message: string, level: LogLevel): void;
+    runQueue(): Promise<void>;
+    private writeToFile;
+}

package/dist/src/Queue.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Queue = void 0;
+const fs = require("fs/promises");
+const path = require("path");
+const Logger_1 = require("./Logger");
+class Queue {
+    logQueue;
+    isRunning;
+    logDir;
+    constructor(options) {
+        this.logQueue = [];
+        this.isRunning = false;
+        this.logDir = options?.directory ?? 'Logs';
+        this.checkLogDir();
+    }
+    async checkLogDir() {
+        try {
+            await fs.mkdir(this.logDir);
+            await Logger_1.Logger.get().debug(`Logs folder generated. Logging to: ${this.logDir}`);
+        }
+        catch (error) {
+            await Logger_1.Logger.get().debug(`Logs folder already exists. Logging to: ${this.logDir}`);
+        }
+    }
+    add(message, level) {
+        this.logQueue.push({ message, level });
+        if (!this.isRunning) {
+            this.isRunning = true;
+            this.runQueue();
+        }
+    }
+    async runQueue() {
+        const { message, level } = this.logQueue.shift();
+        await this.writeToFile(message, level);
+        if (this.logQueue.length) {
+            return this.runQueue();
+        }
+        this.isRunning = false;
+    }
+    async writeToFile(message, level) {
+        const DAY = new Date().getDate();
+        const MONTH = new Date().getMonth() + 1;
+        const YEAR = new Date().getFullYear();
+        const HOURS = new Date().getHours();
+        const MINUTES = new Date().getMinutes();
+        const FULL_DATE = [DAY, MONTH, YEAR].join('-');
+        const FULL_TIME = [HOURS, MINUTES].join(':');
+        let logFile;
+        try {
+            logFile = await fs.readFile(path.join(this.logDir, `${FULL_DATE}-${level}.log`));
+        }
+        catch (e) {
+            const data = 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
+            await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${level}.log`), data);
+        }
+        if (logFile) {
+            const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
+            await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${level}.log`), data);
+        }
+    }
+}
+exports.Queue = Queue;
+//# sourceMappingURL=Queue.js.map

package/dist/src/Queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Queue.js","sourceRoot":"./","sources":["src/Queue.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAClC,6BAA6B;AAE7B,qCAAgC;AAEhC,MAAa,KAAK;IACR,QAAQ,CAAc;IACtB,SAAS,CAAU;IACV,MAAM,CAAS;IAEhC,YAAY,OAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC;QAC3C,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAGO,KAAK,CAAC,WAAW;QACvB,IAAI;YACF,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,MAAM,eAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,sCAAsC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SAC/E;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,eAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,2CAA2C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SACpF;IACH,CAAC;IAGD,GAAG,CAAC,OAAe,EAAE,KAAe;QAClC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;SACjB;IACH,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjD,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;SACxB;QACD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAGO,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,KAAe;QACxD,MAAM,GAAG,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACzC,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAChD,MAAM,IAAI,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAW,IAAI,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QAEhD,MAAM,SAAS,GAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,SAAS,GAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,OAAwB,CAAC;QAC7B,IAAI;YACF,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,KAAK,MAAM,CAAC,CACpD,CAAC;SACH;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;YAChE,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,KAAK,MAAM,CAAC,EACnD,IAAI,CACL,CAAC;SACH;QAED,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,GAAG,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;YAC1E,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,KAAK,MAAM,CAAC,EACnD,IAAI,CACL,CAAC;SACH;IACH,CAAC;CACF;AAxED,sBAwEC"}

package/dist/src/Types.d.ts

@@ -1,5 +1,12 @@
-export declare type Primitives = string | number | object;
+export type Primitives = string | number | object;
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+export type LogObject = {
+    message: string;
+    level: LogLevel;
+};
 export interface ILogger {
     directory?: string;
     logToConsole?: boolean;
+    logToFile?: boolean;
+    level?: LogLevel;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ricdotnet/logger",
-  "version": "0.0.11",
+  "version": "0.2.0",
   "description": "A logger utility for my personal projects.",
   "main": "index.js",
   "scripts": {
@@ -25,8 +25,10 @@
   "devDependencies": {
     "@types/jest": "^27.4.1",
     "jest": "^27.5.1",
+    "prettier": "3.1.1",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
     "typescript": "^4.6.3"
-  }
+  },
+  "dependencies": {}
 }

package/src/Logger.ts

@@ -1,71 +1,80 @@
 import * as fs from 'fs/promises';
-import * as path from 'path';
 import { Constants } from './Constants';
-import { ILogger, Primitives } from './Types';
+import { ILogger, LogLevel } from './Types';
+import { Queue } from './Queue';
 
 export class Logger {
-
   private readonly logDir: string;
   private readonly logToConsole: boolean;
+  private readonly logToFile: boolean;
+  private readonly level: LogLevel;
+  private static logger: Logger = null;
+
+  private readonly logQueue: Queue;
 
   constructor(options?: ILogger) {
-    this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
+    console.log('Initiating a logger...');
+    if (Logger.logger) {
+      console.warn('The logger was already initiated.');
+      return;
+    }
+
     this.logToConsole = options?.logToConsole ?? true;
-    this.checkLogDir();
-  }
+    this.logToFile = options?.logToFile ?? false;
+    this.level = options?.level ?? 'info';
 
-  async checkLogDir() {
-    try {
-      await fs.mkdir(this.logDir);
-      await this.info(`Logs folder generated. Logging to: ${this.logDir}`);
-    } catch (error) {
-      await this.info(`Logs folder already exists. Logging to: ${this.logDir}`);
+    Logger.logger = this;
+
+    if (this.logToFile) {
+      this.logQueue = new Queue(options);
     }
+
+    console.log('Logger initiated.');
   }
 
-  async info<T = string>(message: T | Primitives) {
-    await this.writeToFile(JSON.stringify(message), 'info');
-    if (this.logToConsole) {
-      console.log(`${Constants.TEXT_BLUE}[INFO]:${Constants.RESET} ${JSON.stringify(message)}`);
+  static get(): Logger {
+    return Logger.logger;
+  }
+
+  async debug(message: string) {
+    if (this.logToFile) {
+      this.logQueue.add(message, 'debug');
+    }
+    if (this.logToConsole && this.level === 'debug') {
+      console.debug(
+        `${Constants.TEXT_CYAN}[DEBUG]:${Constants.RESET} ${message}`,
+      );
     }
   }
 
-  async warn<T = string>(message: T | Primitives) {
-    await this.writeToFile(JSON.stringify(message), 'warn');
+  async info(message: string) {
+    if (this.logToFile) {
+      this.logQueue.add(message, 'info');
+    }
     if (this.logToConsole) {
-      console.warn(`${Constants.TEXT_YELLOW}[WARN]:${Constants.RESET} ${JSON.stringify(message)}`);
+      console.log(`${Constants.TEXT_BLUE}[INFO]:${Constants.RESET} ${message}`);
     }
   }
 
-  async error<T = string>(message: T | Primitives) {
-    await this.writeToFile(JSON.stringify(message), 'error');
+  async warn(message: string) {
+    if (this.logToFile) {
+      this.logQueue.add(message, 'warn');
+    }
     if (this.logToConsole) {
-      console.error(`${Constants.TEXT_RED}[ERROR]:${Constants.RESET} ${JSON.stringify(message)}`);
+      console.warn(
+        `${Constants.TEXT_YELLOW}[WARN]:${Constants.RESET} ${message}`,
+      );
     }
   }
 
-  async writeToFile(message: any, type: string) {
-    const DAY: number = new Date().getDate();
-    const MONTH: number = new Date().getMonth() + 1; // +1 because it goes 0-11
-    const YEAR: number = new Date().getFullYear();
-    const HOURS: number = new Date().getHours();
-    const MINUTES: number = new Date().getMinutes();
-
-    const FULL_DATE: string = [DAY, MONTH, YEAR].join('-');
-    const FULL_TIME: string = [HOURS, MINUTES].join(':');
-
-    let logFile;
-    try {
-      logFile = await fs.readFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`));
-    } catch (e) {
-      const data = 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
-      await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
+  async error(message: string) {
+    if (this.logToFile) {
+      this.logQueue.add(message, 'error');
     }
-
-    if (logFile) {
-      const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
-      await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
+    if (this.logToConsole) {
+      console.error(
+        `${Constants.TEXT_RED}[ERROR]:${Constants.RESET} ${message}`,
+      );
     }
   }
-
 }

package/src/Queue.ts

@@ -0,0 +1,78 @@
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import { ILogger, LogLevel, LogObject } from './Types';
+import {Logger} from "./Logger";
+
+export class Queue {
+  private logQueue: LogObject[];
+  private isRunning: boolean;
+  private readonly logDir: string;
+
+  constructor(options: ILogger) {
+    this.logQueue = [];
+    this.isRunning = false;
+    this.logDir = options?.directory ?? 'Logs';
+    this.checkLogDir();
+  }
+
+  // TODO: update this maybe
+  private async checkLogDir() {
+    try {
+      await fs.mkdir(this.logDir);
+      await Logger.get().debug(`Logs folder generated. Logging to: ${this.logDir}`);
+    } catch (error) {
+      await Logger.get().debug(`Logs folder already exists. Logging to: ${this.logDir}`);
+    }
+  }
+
+
+  add(message: string, level: LogLevel) {
+    this.logQueue.push({ message, level });
+    if (!this.isRunning) {
+      this.isRunning = true;
+      this.runQueue();
+    }
+  }
+
+  async runQueue(): Promise<void> {
+    const { message, level } = this.logQueue.shift();
+    await this.writeToFile(message, level);
+    if (this.logQueue.length) {
+      return this.runQueue();
+    }
+    this.isRunning = false;
+  }
+
+  // TODO: rewrite better...
+  private async writeToFile(message: string, level: LogLevel) {
+    const DAY: number = new Date().getDate();
+    const MONTH: number = new Date().getMonth() + 1; // +1 because it goes 0-11
+    const YEAR: number = new Date().getFullYear();
+    const HOURS: number = new Date().getHours();
+    const MINUTES: number = new Date().getMinutes();
+
+    const FULL_DATE: string = [DAY, MONTH, YEAR].join('-');
+    const FULL_TIME: string = [HOURS, MINUTES].join(':');
+
+    let logFile: string | Buffer;
+    try {
+      logFile = await fs.readFile(
+        path.join(this.logDir, `${FULL_DATE}-${level}.log`),
+      );
+    } catch (e) {
+      const data = 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
+      await fs.writeFile(
+        path.join(this.logDir, `${FULL_DATE}-${level}.log`),
+        data,
+      );
+    }
+
+    if (logFile) {
+      const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
+      await fs.writeFile(
+        path.join(this.logDir, `${FULL_DATE}-${level}.log`),
+        data,
+      );
+    }
+  }
+}

package/src/Types.ts

@@ -1,6 +1,14 @@
 export type Primitives = string | number | object;
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+
+export type LogObject = {
+  message: string;
+  level: LogLevel;
+};
 
 export interface ILogger {
   directory?: string;
   logToConsole?: boolean;
+  logToFile?: boolean;
+  level?: LogLevel;
 }

package/Logs/29-8-2022-error.log

@@ -1,24 +0,0 @@
-Log Time: 11:13
-hello world
-
-Log Time: 11:13
-hello world
-
-Log Time: 11:14
-hello world
-
-Log Time: 11:15
-hello world
-
-Log Time: 11:18
-hello world
-
-Log Time: 11:19
-hello world
-
-Log Time: 11:19
-hello world
-
-Log Time: 11:20
-hello world
-

package/Logs/29-8-2022-info.log

@@ -1,27 +0,0 @@
-Log Time: 11:13
-hello world
-
-Log Time: 11:13
-Logs folder generated.
-
-Log Time: 11:13
-hello world
-
-Log Time: 11:14
-hello world
-
-Log Time: 11:15
-hello world
-
-Log Time: 11:18
-hello world
-
-Log Time: 11:19
-hello world
-
-Log Time: 11:19
-hello world
-
-Log Time: 11:20
-hello world
-

package/Logs/29-8-2022-warn.log

@@ -1,33 +0,0 @@
-Log Time: 11:13
-hello world
-
-Log Time: 11:13
-hello world
-
-Log Time: 11:14
-hello world
-
-Log Time: 11:15
-hello world
-
-Log Time: 11:17
-hello world
-
-Log Time: 11:17
-hello world
-
-Log Time: 11:17
-hello world
-
-Log Time: 11:18
-hello world
-
-Log Time: 11:19
-hello world
-
-Log Time: 11:19
-hello world
-
-Log Time: 11:20
-hello world
-

package/index.ts

@@ -1 +0,0 @@
-export { Logger } from './src/Logger';

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "target": "esnext",
-    "sourceMap": true,
-    "removeComments": true,
-    "outDir": "dist",
-    "sourceRoot": "./",
-    "allowJs": true,
-    "declaration": true,
-    "resolveJsonModule": true
-  },
-  "exclude": [
-    "node_modules",
-    "Tests",
-    "jest.config.js",
-  ]
-}