@ricdotnet/logger 0.0.10 → 0.0.11

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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,33 @@
+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/Tests/Logger.spec.ts

@@ -0,0 +1,55 @@
+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'),
+};
+
+describe('Logger test', () => {
+  let loggerInstance;
+  let loggerSpy;
+
+  beforeEach(() => {
+    loggerInstance = new Logger();
+
+    loggerSpy = {
+      info: jest.spyOn(loggerInstance, 'info'),
+      warn: jest.spyOn(loggerInstance, 'warn'),
+      error: jest.spyOn(loggerInstance, 'error')
+    };
+
+    loggerSpy.info.mockClear();
+    loggerSpy.warn.mockClear();
+    loggerSpy.error.mockClear();
+  });
+
+  it('can log an info', async () => {
+    await loggerInstance.info('hello world');
+
+    await expect(loggerSpy.info).toHaveBeenCalledWith('hello world');
+    await expect(consoleSpy.info).toHaveBeenCalledWith(`${Constants.TEXT_BLUE}[INFO]: hello world`);
+  });
+
+  it('can log a warning', () => {
+    loggerInstance.warn('hello world');
+
+    expect(loggerSpy.warn).toHaveBeenCalledWith('hello world');
+    // expect(consoleSpy.warn).toHaveBeenCalledWith(`${Constants.TEXT_YELLOW}[WARN]: hello world`);
+  });
+
+  it('can log an error', () => {
+    loggerInstance.error('hello world');
+
+    expect(loggerSpy.error).toHaveBeenCalledWith('hello world');
+    expect(consoleSpy.error).toHaveBeenCalledWith(`${Constants.TEXT_RED}[ERROR]: hello world`);
+  });
+});

package/{src → dist/src}/Logger.d.ts

@@ -1,6 +1,7 @@
 import { ILogger, Primitives } from './Types';
 export declare class Logger {
     private readonly logDir;
+    private readonly logToConsole;
     constructor(options?: ILogger);
     checkLogDir(): Promise<void>;
     info<T = string>(message: T | Primitives): Promise<void>;

package/{src → dist/src}/Logger.js

@@ -6,8 +6,10 @@ const path = require("path");
 const Constants_1 = require("./Constants");
 class Logger {
     logDir;
+    logToConsole;
     constructor(options) {
         this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
+        this.logToConsole = options?.logToConsole ?? true;
         this.checkLogDir();
     }
     async checkLogDir() {
@@ -21,15 +23,21 @@ class Logger {
     }
     async info(message) {
         await this.writeToFile(JSON.stringify(message), 'info');
-        console.log(`${Constants_1.Constants.TEXT_BLUE}[INFO]: ${JSON.stringify(message)}`);
+        if (this.logToConsole) {
+            console.log(`${Constants_1.Constants.TEXT_BLUE}[INFO]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
+        }
     }
     async warn(message) {
         await this.writeToFile(JSON.stringify(message), 'warn');
-        console.warn(`${Constants_1.Constants.TEXT_YELLOW}[WARN]: ${JSON.stringify(message)}`);
+        if (this.logToConsole) {
+            console.warn(`${Constants_1.Constants.TEXT_YELLOW}[WARN]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
+        }
     }
     async error(message) {
         await this.writeToFile(JSON.stringify(message), 'error');
-        console.error(`${Constants_1.Constants.TEXT_RED}[ERROR]: ${JSON.stringify(message)}`);
+        if (this.logToConsole) {
+            console.error(`${Constants_1.Constants.TEXT_RED}[ERROR]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
+        }
     }
     async writeToFile(message, type) {
         const DAY = new Date().getDate();

package/dist/src/Logger.js.map

@@ -0,0 +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"}

package/{src → dist/src}/Types.d.ts

@@ -1,4 +1,5 @@
 export declare type Primitives = string | number | object;
 export interface ILogger {
     directory?: string;
+    logToConsole?: boolean;
 }

package/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ricdotnet/logger",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "A logger utility for my personal projects.",
   "main": "index.js",
   "scripts": {

package/src/Constants.ts

@@ -0,0 +1,27 @@
+export enum Constants {
+  RESET        = '\x1b[0m',
+  BRIGHT       = '\x1b[1m',
+  DIM          = '\x1b[2m',
+  UNDERSCORE   = '\x1b[4m',
+  BLINK        = '\x1b[5m',
+  REVERSE      = '\x1b[7m',
+  HIDDEN       = '\x1b[8m',
+
+  TEXT_BLACK   = '\x1b[30m',
+  TEXT_RED     = '\x1b[31m',
+  TEXT_GREEN   = '\x1b[32m',
+  TEXT_YELLOW  = '\x1b[33m',
+  TEXT_BLUE    = '\x1b[34m',
+  TEXT_MAGENTA = '\x1b[35m',
+  TEXT_CYAN    = '\x1b[36m',
+  TEXT_WHITE   = '\x1b[37m',
+
+  BG_BLACK     = '\x1b[40m',
+  BG_RED       = '\x1b[41m',
+  BG_GREEN     = '\x1b[42m',
+  BG_YELLOW    = '\x1b[43m',
+  BG_BLUE      = '\x1b[44m',
+  BG_MAGENTA   = '\x1b[45m',
+  BG_CYAN      = '\x1b[46m',
+  BG_WHITE     = '\x1b[47m',
+}

package/src/Logger.ts

@@ -0,0 +1,71 @@
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import { Constants } from './Constants';
+import { ILogger, Primitives } from './Types';
+
+export class Logger {
+
+  private readonly logDir: string;
+  private readonly logToConsole: boolean;
+
+  constructor(options?: ILogger) {
+    this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
+    this.logToConsole = options?.logToConsole ?? true;
+    this.checkLogDir();
+  }
+
+  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}`);
+    }
+  }
+
+  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)}`);
+    }
+  }
+
+  async warn<T = string>(message: T | Primitives) {
+    await this.writeToFile(JSON.stringify(message), 'warn');
+    if (this.logToConsole) {
+      console.warn(`${Constants.TEXT_YELLOW}[WARN]:${Constants.RESET} ${JSON.stringify(message)}`);
+    }
+  }
+
+  async error<T = string>(message: T | Primitives) {
+    await this.writeToFile(JSON.stringify(message), 'error');
+    if (this.logToConsole) {
+      console.error(`${Constants.TEXT_RED}[ERROR]:${Constants.RESET} ${JSON.stringify(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);
+    }
+
+    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);
+    }
+  }
+
+}

package/src/Types.ts

@@ -0,0 +1,6 @@
+export type Primitives = string | number | object;
+
+export interface ILogger {
+  directory?: string;
+  logToConsole?: boolean;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "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",
+  ]
+}

package/src/Logger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Logger.js","sourceRoot":"./","sources":["src/Logger.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAClC,6BAA6B;AAC7B,2CAAwC;AAGxC,MAAa,MAAM;IAEA,MAAM,CAAS;IAEhC,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,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,OAAO,CAAC,GAAG,CAAC,GAAG,qBAAS,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;QACxD,OAAO,CAAC,IAAI,CAAC,GAAG,qBAAS,CAAC,WAAW,WAAW,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,KAAK,CAAa,OAAuB;QAC7C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACzD,OAAO,CAAC,KAAK,CAAC,GAAG,qBAAS,CAAC,QAAQ,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5E,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;AAzDD,wBAyDC"}