feat: added initial Logger implementation

Author: ralvarezdev

.gitignore

@@ -0,0 +1,25 @@
+# IDE folders
+/.idea
+/.vscode
+
+# Node modules
+/node_modules
+
+# Environment variables
+/**/*.env
+
+# Executable files
+/**/*.exe
+
+# Private and public keys
+/**/*.ed
+/**/*.pub
+/**/*.pem
+
+# Commands
+/**/*.cmd
+/**/*.sh
+/**/*.bat
+
+# NPM configuration
+/.npmrc

index.js

@@ -0,0 +1,3 @@
+import Logger from "./lib/logger.js";
+
+export default Logger;

lib/date.js

@@ -0,0 +1,15 @@
+// Get the current date in the format
+function GetFormattedDate({
+                              locales = "en-US",
+                              options = {
+                                  year: 'numeric',
+                                  month: '2-digit',
+                                  day: '2-digit',
+                                  hour: '2-digit',
+                                  minute: '2-digit',
+                                  second: '2-digit'
+                              }
+                          }) {
+    const date = new Date();
+    return new Intl.DateTimeFormat(locales, options).format(date);
+}

lib/log_entry.js

@@ -0,0 +1,32 @@
+// LogEntry is a class that represents a log entry
+import GetFormattedDate from "./date.js";
+
+// Log entry types
+export const LogEntryType = {
+    ERROR: 'ERROR',
+    INFO: 'INFO',
+    DEBUG: 'DEBUG',
+    WARNING: 'WARNING',
+    CRITICAL: 'CRITICAL'
+};
+
+export default class LogEntry {
+    #type;
+    #message;
+    #locales
+    #options
+
+    // Constructor of the class
+    constructor({type = LogEntryType.INFO, message = "", locales, options}) {
+        // Set the properties of the log entry
+        this.#type = type;
+        this.#message = message;
+        this.#locales = locales;
+        this.#options = options;
+    }
+
+    // String representation of the log entry
+    toString() {
+        return `${GetFormattedDate()} [${this.#type}]: ${this.#message}`;
+    }
+}

lib/logger.js

@@ -0,0 +1,143 @@
+import path from 'path';
+import fs from 'fs';
+import LogEntry, {LogEntryType} from "./log_entry.js";
+
+// Errors that can be thrown by the Logger class
+export const ErrMissingLogPath = new Error('log output directory is required');
+export const ErrMissingLogFilename = new Error('log filename is required');
+
+// Logger  is a class that logs messages to the console and to a file.
+export default class Logger {
+    #save
+    #logPath
+    #logFilename
+    #logFilePath
+    #error
+    #info
+    #debug
+    #warning
+    #format
+
+    // The constructor receives an object with the properties to configure the logger
+    constructor({
+                    save = false,
+                    logPath = "",
+                    logFilename = "",
+                    error = true,
+                    info = true,
+                    debug = true,
+                    warning = true,
+                    format = {
+                        locales: 'en-US',
+                        options: {
+                            year: 'numeric',
+                            month: '2-digit',
+                            day: '2-digit',
+                            hour: '2-digit',
+                            minute: '2-digit',
+                            second: '2-digit',
+                            hour12: false
+                        }
+                    }
+                }) {
+        // Set the properties of the logger
+        this.#save = save;
+        this.#logPath = logPath;
+        this.#error = error;
+        this.#info = info;
+        this.#debug = debug;
+        this.#warning = warning;
+        this.#format = format;
+
+        // Check if the save property is true
+        if (save) {
+            // Check if the logPath or logFilename property is empty
+            if (logPath === "") {
+                throw ErrMissingLogPath;
+            }
+            if (logFilename === "") {
+                throw ErrMissingLogFilename;
+            }
+
+            // Check if the logPath directory exists
+            this.#logPath = path.join(__dirname, logPath);
+            if (!fs.existsSync(this.#logPath)) {
+                fs.mkdirSync(this.#logPath);
+            }
+
+            // Check if the logFilename file exists
+            this.#logFilename = logFilename
+            this.#logFilePath = path.join(this.#logPath, logFilename);
+            if (!fs.existsSync(this.#logFilename)) {
+                fs.writeFileSync(this.#logFilename, "");
+            }
+        }
+    }
+
+    // Append a log entry to the log file
+    #appendLogEntryToFile(logEntry) {
+        fs.appendFile(this.#logFilePath, logEntry, err => {
+            if (err) throw err;
+        });
+    }
+
+    // Write a log entry to the log file
+    log({type = LogEntryType.INFO, message = ""}) {
+        // Create a new LogEntry object
+        const logEntry = new LogEntry({
+            type,
+            message,
+            locales: this.#format.locales,
+            options: this.#format.options,
+        });
+
+        // Format the log entry as a string
+        const logEntryStr = String(logEntry);
+
+        // Check if the save property is true
+        if (this.#save) {
+            this.#appendLogEntryToFile(logEntryStr + "\n");
+        }
+        console.log(logEntryStr);
+    }
+
+    // Write an error log entry to the log file
+    error(message) {
+        this.log({
+            type: LogEntryType.ERROR,
+            message,
+        });
+    }
+
+    // Write an info log entry to the log file
+    info(message) {
+        this.log({
+            type: LogEntryType.INFO,
+            message
+        });
+    }
+
+    // Write a warning log entry to the log file
+    warning(message) {
+        this.log({
+            type: LogEntryType.WARNING,
+            message
+        });
+    }
+
+    // Write a debug log entry to the log file
+    debug(message) {
+        this.log({
+            type: LogEntryType.DEBUG,
+            message
+        });
+    }
+
+    // Write a critical log entry to the log file
+    critical(message) {
+        this.log({
+            type: LogEntryType.CRITICAL,
+            message
+        });
+    }
+}

package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@ralvarezdev/js-logger",
+  "version": "0.1.0",
+  "description": "Logger for JavaScript Projects",
+  "main": "index.js",
+  "scripts": {
+    "test": "exit 0"
+  },
+  "keywords": [],
+  "author": "Ramón Álvarez",
+  "license": "ISC",
+  "type": "module",
+  "publishConfig": {
+    "@ralvarezdev:registry": "https://npm.pkg.github.com"
+  }
+}