@ricdotnet/logger 0.0.1

package/Tests/Logger.spec.ts

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

package/index.ts

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

package/jest.config.js

@@ -0,0 +1,11 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: [
+    '<rootDir>',
+  ],
+  moduleDirectories: [
+    'node_modules'
+  ],
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@ricdotnet/logger",
+  "version": "0.0.1",
+  "description": "A logger utility for my personal projects.",
+  "main": "index.js",
+  "scripts": {
+    "start": "node dist/index.js",
+    "dev": "ts-node index.ts",
+    "build": "rm -rf ./dist && tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "ricdotnet <me@rrocha.uk> https://ricr.dev",
+  "repository": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3"
+  }
+}

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,65 @@
+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]
+
+export class Logger {
+
+  static LOG_DIR = './Logs';
+
+  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.');
+    }
+
+    // return this.info('Logs folder already exists... The logger will write inside it.');
+  }
+
+  static async info(message: any) {
+    await this.writeToFile(message, 'info');
+    console.log(`${Constants.TEXT_BLUE}[INFO]: ${message}`);
+  }
+
+  static async warn(message: any) {
+    await this.writeToFile(message, 'warn');
+    console.warn(`${Constants.TEXT_YELLOW}[WARN]: ${message}`);
+  }
+
+  static async error(message: any) {
+    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();
+    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.LOG_DIR, `${FULL_DATE}-${type}.log`));
+    } catch (e) {
+      // console.error(e);
+      // let me just fail silently if the file does not exist
+    }
+
+    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';
+    return await fs.writeFile(path.join(this.LOG_DIR, `${FULL_DATE}-${type}.log`), data);
+  }
+
+}

package/tsconfig.json

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