@ricdotnet/logger 0.0.2 → 0.0.5

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

@@ -1,42 +1,53 @@
 import { Logger } from '../src/Logger';
 import { Constants } from '../src/Constants';
 
-const loggerSpy = {
-  info : jest.spyOn(Logger, 'info'),
-  warn : jest.spyOn(Logger, 'warn'),
-  error: jest.spyOn(Logger, 'error')
-};
+
+// 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'),
+  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 and check the output', () => {
-    Logger.info('hello world');
+  it('can log an info', async () => {
+    await loggerInstance.info('hello world');
 
-    expect(loggerSpy.info).toHaveBeenCalledWith('hello world');
-    expect(consoleSpy.info).toHaveBeenCalledWith(`${Constants.TEXT_BLUE}[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', () => {
-    Logger.warn('hello world');
+    loggerInstance.warn('hello world');
 
     expect(loggerSpy.warn).toHaveBeenCalledWith('hello world');
-    expect(consoleSpy.warn).toHaveBeenCalledWith(`${Constants.TEXT_YELLOW}[WARN]: hello world`);
+    // expect(consoleSpy.warn).toHaveBeenCalledWith(`${Constants.TEXT_YELLOW}[WARN]: hello world`);
   });
 
   it('can log an error', () => {
-    Logger.error('hello world');
+    loggerInstance.error('hello world');
 
     expect(loggerSpy.error).toHaveBeenCalledWith('hello world');
     expect(consoleSpy.error).toHaveBeenCalledWith(`${Constants.TEXT_RED}[ERROR]: hello world`);

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+var Logger_1 = require("./src/Logger");
+Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return Logger_1.Logger; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"./","sources":["index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,gGAAA,MAAM,OAAA"}

package/dist/src/Constants.d.ts

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

package/dist/src/Constants.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Constants = void 0;
+var Constants;
+(function (Constants) {
+    Constants["RESET"] = "\u001B[0m";
+    Constants["BRIGHT"] = "\u001B[1m";
+    Constants["DIM"] = "\u001B[2m";
+    Constants["UNDERSCORE"] = "\u001B[4m";
+    Constants["BLINK"] = "\u001B[5m";
+    Constants["REVERSE"] = "\u001B[7m";
+    Constants["HIDDEN"] = "\u001B[8m";
+    Constants["TEXT_BLACK"] = "\u001B[30m";
+    Constants["TEXT_RED"] = "\u001B[31m";
+    Constants["TEXT_GREEN"] = "\u001B[32m";
+    Constants["TEXT_YELLOW"] = "\u001B[33m";
+    Constants["TEXT_BLUE"] = "\u001B[34m";
+    Constants["TEXT_MAGENTA"] = "\u001B[35m";
+    Constants["TEXT_CYAN"] = "\u001B[36m";
+    Constants["TEXT_WHITE"] = "\u001B[37m";
+    Constants["BG_BLACK"] = "\u001B[40m";
+    Constants["BG_RED"] = "\u001B[41m";
+    Constants["BG_GREEN"] = "\u001B[42m";
+    Constants["BG_YELLOW"] = "\u001B[43m";
+    Constants["BG_BLUE"] = "\u001B[44m";
+    Constants["BG_MAGENTA"] = "\u001B[45m";
+    Constants["BG_CYAN"] = "\u001B[46m";
+    Constants["BG_WHITE"] = "\u001B[47m";
+})(Constants = exports.Constants || (exports.Constants = {}));
+//# sourceMappingURL=Constants.js.map

package/dist/src/Constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.js","sourceRoot":"./","sources":["src/Constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,SA0BX;AA1BD,WAAY,SAAS;IACnB,gCAAwB,CAAA;IACxB,iCAAwB,CAAA;IACxB,8BAAwB,CAAA;IACxB,qCAAwB,CAAA;IACxB,gCAAwB,CAAA;IACxB,kCAAwB,CAAA;IACxB,iCAAwB,CAAA;IAExB,sCAAyB,CAAA;IACzB,oCAAyB,CAAA;IACzB,sCAAyB,CAAA;IACzB,uCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,wCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,sCAAyB,CAAA;IAEzB,oCAAyB,CAAA;IACzB,kCAAyB,CAAA;IACzB,oCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,mCAAyB,CAAA;IACzB,sCAAyB,CAAA;IACzB,mCAAyB,CAAA;IACzB,oCAAyB,CAAA;AAC3B,CAAC,EA1BW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QA0BpB"}

package/dist/src/Logger.d.ts

@@ -0,0 +1,10 @@
+import { ILogger, Primitives } from './Types';
+export declare class Logger {
+    private readonly logDir;
+    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>;
+}

package/dist/src/Logger.js

@@ -0,0 +1,61 @@
+"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");
+class Logger {
+    logDir;
+    constructor(options) {
+        this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
+        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(message) {
+        await this.writeToFile(message, 'info');
+        console.log(`${Constants_1.Constants.TEXT_BLUE}[INFO]: ${message}`);
+    }
+    async warn(message) {
+        await this.writeToFile(message, 'warn');
+        console.warn(`${Constants_1.Constants.TEXT_YELLOW}[WARN]: ${message}`);
+    }
+    async error(message) {
+        await this.writeToFile(message, 'error');
+        console.error(`${Constants_1.Constants.TEXT_RED}[ERROR]: ${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) {
+            try {
+                if (!logFile) {
+                    const data = 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
+                    await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
+                }
+                const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
+                await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
+            }
+            catch (error) {
+            }
+        }
+    }
+}
+exports.Logger = Logger;
+//# sourceMappingURL=Logger.js.map

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;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,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,GAAG,qBAAS,CAAC,SAAS,WAAW,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,GAAG,qBAAS,CAAC,WAAW,WAAW,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,KAAK,CAAa,OAAuB;QAC7C,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,CAAC,KAAK,CAAC,GAAG,qBAAS,CAAC,QAAQ,YAAY,OAAO,EAAE,CAAC,CAAC;IAC5D,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,IAAI;gBACF,IAAK,CAAC,OAAO,EAAG;oBACd,MAAM,IAAI,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;oBAChE,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;iBAC9E;gBAED,MAAM,IAAI,GAAG,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;gBAC1E,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;aAC9E;YAAC,OAAO,KAAK,EAAE;aACf;SACF;IACH,CAAC;CAEF;AA5DD,wBA4DC"}

package/dist/src/Types.d.ts

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

package/dist/src/Types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Types.js.map

package/dist/src/Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Types.js","sourceRoot":"./","sources":["src/Types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ricdotnet/logger",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "A logger utility for my personal projects.",
   "main": "index.js",
   "scripts": {
@@ -9,7 +9,16 @@
     "build": "rm -rf ./dist && tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": ["logger", "logs", "console.log", "log", "logjs", "logts", "logger4ts", "logger4js"],
+  "keywords": [
+    "logger",
+    "logs",
+    "console.log",
+    "log",
+    "logjs",
+    "logts",
+    "logger4ts",
+    "logger4js"
+  ],
   "author": "ricdotnet <me@rrocha.uk> https://ricr.dev",
   "repository": "https://github.com/ricdotnet/logger-utility",
   "license": "ISC",

package/src/Constants.ts

@@ -1,11 +1,11 @@
 export enum Constants {
-  Reset        = '\x1b[0m',
+  RESET        = '\x1b[0m',
   BRIGHT       = '\x1b[1m',
-  Dim          = '\x1b[2m',
-  Underscore   = '\x1b[4m',
-  Blink        = '\x1b[5m',
-  Reverse      = '\x1b[7m',
-  Hidden       = '\x1b[8m',
+  DIM          = '\x1b[2m',
+  UNDERSCORE   = '\x1b[4m',
+  BLINK        = '\x1b[5m',
+  REVERSE      = '\x1b[7m',
+  HIDDEN       = '\x1b[8m',
 
   TEXT_BLACK   = '\x1b[30m',
   TEXT_RED     = '\x1b[31m',

package/src/Logger.ts

@@ -1,45 +1,46 @@
 import * as fs from 'fs/promises';
 import * as path from 'path';
 import { Constants } from './Constants';
-
-// some places use any just because I do not want to deal with multiple types of data...
-// I guess generics would be cool here but eh
-// TODO: Multiple log folders for [info, warn, error]
+import { ILogger, Primitives } from './Types';
 
 export class Logger {
 
-  static LOG_DIR = './Logs';
+  private readonly logDir: string;
 
-  static async checkLogDir() {
-    const dirs = await fs.readdir('./');
-    if ( !dirs.includes(this.LOG_DIR.split('/')[1]) ) {
-      await fs.mkdir(this.LOG_DIR);
-      return this.info('Logs folder generated.');
-    }
+  constructor(options?: ILogger) {
+    this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
+    this.checkLogDir();
+  }
 
-    // return this.info('Logs folder already exists... The logger will write inside it.');
+  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}`);
+    }
   }
 
-  static async info(message: any) {
+  async info<T = string>(message: T | Primitives) {
     await this.writeToFile(message, 'info');
     console.log(`${Constants.TEXT_BLUE}[INFO]: ${message}`);
   }
 
-  static async warn(message: any) {
+  async warn<T = string>(message: T | Primitives) {
     await this.writeToFile(message, 'warn');
     console.warn(`${Constants.TEXT_YELLOW}[WARN]: ${message}`);
   }
 
-  static async error(message: any) {
+  async error<T = string>(message: T | Primitives) {
     await this.writeToFile(message, 'error');
     console.error(`${Constants.TEXT_RED}[ERROR]: ${message}`);
   }
 
-  static 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();
+  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('-');
@@ -47,19 +48,19 @@ export class Logger {
 
     let logFile;
     try {
-      logFile = await fs.readFile(path.join(this.LOG_DIR, `${FULL_DATE}-${type}.log`));
+      logFile = await fs.readFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`));
     } catch (e) {
-      // console.error(e);
-      // let me just fail silently if the file does not exist
-    }
+      try {
+        if ( !logFile ) {
+          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 = 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
-      return await fs.writeFile(path.join(this.LOG_DIR, `${FULL_DATE}-${type}.log`), data);
+        const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
+        await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
+      } catch (error) {
+      }
     }
-
-    const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
-    return await fs.writeFile(path.join(this.LOG_DIR, `${FULL_DATE}-${type}.log`), data);
   }
 
 }

package/src/Types.ts

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

package/tsconfig.json

@@ -7,9 +7,12 @@
     "outDir": "dist",
     "sourceRoot": "./",
     "allowJs": true,
-    "declaration": true
+    "declaration": true,
+    "resolveJsonModule": true
   },
   "exclude": [
-    "node_modules"
+    "node_modules",
+    "Tests",
+    "jest.config.js",
   ]
 }