@hackthedev/terminal-logger 1.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/README.md

@@ -0,0 +1,91 @@
+# Terminal Logger
+
+This small library was designed for NodeJS and to bring pretty logs to the terminal. It has the following features:
+
+- `Logger.info` prints in cyan
+- `Logger.warn` prints in yellow
+- `Logger.error` prints in red
+- `Logger.success` prints in green
+- `Logger.debug` will only print if `Logger.logDebug` is set to true and on default in a bright black color.
+- `Logger.log` can be used to print custom "levels", which is whats shown in the `[ ]` brackets, like `INFO`, `SUCCESS` and more.
+- `Logger.space` will print emty lines and supports a number argument to print multiple empty lines without spamming `Logger.space` lines or `console.log` and can be done with `Logger.space(2)` for two empty lines or more.
+
+![image-20260116014526091](./assets/image-20260116014526091.png)
+
+![image-20260116015034925](./assets/image-20260116015034925.png)
+
+------
+
+## Syntax examples
+
+This is a general example
+
+```js
+Logger.info("Content")
+Logger.success("Content")
+Logger.error("Content")
+```
+
+![image-20260116015557446](./assets/image-20260116015557446.png)
+
+### Printing objects
+
+Objects will be printed using `JSON.stringify` 
+
+```js
+let obj = {
+    name: "Marvin"
+}
+
+Logger.info(obj)
+Logger.warn(obj)
+Logger.error(obj)
+Logger.success(obj)
+```
+
+### Custom colors and effects
+
+You can print text with custom supported colors like in the following example. You can also use some special effects depending on your terminal like making text blink, underlined and more.
+
+```js
+Logger.info(`My awesome text`, Logger.colors.fgMagenta)
+Logger.info(`My blinking text`, Logger.colors.blink)
+
+// Alternative, theoretical multicolored words
+Logger.info(`${Logger.colors.fgMagenta} My awesome text`)
+Logger.info(`${Logger.colors.blink} My blinking text`)
+
+```
+
+```js
+// Supported colors and effects 
+static colors = {
+    reset: "\x1b[0m",
+    bright: "\x1b[1m",
+    dim: "\x1b[2m",
+    underscore: "\x1b[4m",
+    blink: "\x1b[5m",
+    reverse: "\x1b[7m",
+    hidden: "\x1b[8m",
+
+    fgBlack: "\x1b[30m",
+    fgRed: "\x1b[31m",
+    fgGreen: "\x1b[32m",
+    fgYellow: "\x1b[33m",
+    fgBlue: "\x1b[34m",
+    fgMagenta: "\x1b[35m",
+    fgCyan: "\x1b[36m",
+    fgWhite: "\x1b[37m",
+    fgGray: "\x1b[90m",
+
+    bgBlack: "\x1b[40m",
+    bgRed: "\x1b[41m",
+    bgGreen: "\x1b[42m",
+    bgYellow: "\x1b[43m",
+    bgBlue: "\x1b[44m",
+    bgMagenta: "\x1b[45m",
+    bgCyan: "\x1b[46m",
+    bgWhite: "\x1b[47m"
+};
+```
+

package/index.mjs

@@ -0,0 +1,76 @@
+export default class Logger {
+    static logDebug = false;
+
+    static colors = {
+        reset: "\x1b[0m",
+        bright: "\x1b[1m",
+        dim: "\x1b[2m",
+        underscore: "\x1b[4m",
+        blink: "\x1b[5m",
+        reverse: "\x1b[7m",
+        hidden: "\x1b[8m",
+
+        fgBlack: "\x1b[30m",
+        fgRed: "\x1b[31m",
+        fgGreen: "\x1b[32m",
+        fgYellow: "\x1b[33m",
+        fgBlue: "\x1b[34m",
+        fgMagenta: "\x1b[35m",
+        fgCyan: "\x1b[36m",
+        fgWhite: "\x1b[37m",
+        fgGray: "\x1b[90m",
+
+        bgBlack: "\x1b[40m",
+        bgRed: "\x1b[41m",
+        bgGreen: "\x1b[42m",
+        bgYellow: "\x1b[43m",
+        bgBlue: "\x1b[44m",
+        bgMagenta: "\x1b[45m",
+        bgCyan: "\x1b[46m",
+        bgWhite: "\x1b[47m"
+    };
+
+    static log(level, message, color = Logger.colors.fgWhite) {
+        if (message instanceof Error) {
+            console.log(`${color}${Logger.displayDate()}[${level}] ${message.message}\n${message.stack}${Logger.colors.reset}`);
+        } else if (typeof message === 'object') {
+            console.log(`${color}${Logger.displayDate()}[${level}]\n${JSON.stringify(message, null, 4)}${Logger.colors.reset}`);
+        } else {
+            console.log(`${color}${Logger.displayDate()}[${level}] ${message}${Logger.colors.reset}`);
+        }
+    }
+
+    static space(amount = 1){
+        for(let i = 0; i < amount; i++) {
+            console.log(" ");
+        }
+    }
+
+    static info(message, color = "") {
+        Logger.log("INFO", message, color ? Logger.colors.fgCyan + color : Logger.colors.fgCyan);
+    }
+
+    static success(message, color = "") {
+        Logger.log("SUCCESS", message, color ? Logger.colors.fgGreen + color : Logger.colors.fgGreen);
+    }
+
+    static warn(message, color = "") {
+        Logger.log("WARN", message, color ? Logger.colors.fgYellow + color : Logger.colors.fgYellow);
+    }
+
+    static error(message, color = "") {
+        Logger.log("ERROR", message, color ? Logger.colors.fgRed + color : Logger.colors.fgRed);
+    }
+
+    static debug(message, color = "") {
+        if(!Logger.logDebug) return;
+        Logger.log("DEBUG", message, color ? Logger.colors.bright + Logger.colors.fgBlack + color : Logger.colors.bright + Logger.colors.fgBlack);
+    }
+
+    static displayDate() {
+        const today = new Date();
+        const date = today.getFullYear() + '-' + (today.getMonth() + 1).toString().padStart(2, '0') + '-' + today.getDate().toString().padStart(2, '0');
+        const time = today.getHours().toString().padStart(2, '0') + ":" + today.getMinutes().toString().padStart(2, '0') + ":" + today.getSeconds().toString().padStart(2, '0');
+        return `[${date} ${time}] `;
+    }
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@hackthedev/terminal-logger",
+  "version": "1.0.0",
+  "description": "This small library was designed for NodeJS and to bring pretty logs to the terminal. It has the following features:",
+  "homepage": "https://github.com/NETWORK-Z-Dev/terminal-logger#readme",
+  "bugs": {
+    "url": "https://github.com/NETWORK-Z-Dev/terminal-logger/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NETWORK-Z-Dev/terminal-logger.git"
+  },
+  "license": "ISC",
+  "author": "",
+  "main": "index.mjs",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}