log-likho 1.2.1 → 2.0.1

package/CONTRIBUTE.md

@@ -11,6 +11,6 @@ Before creating any Pull requests please follow the guidelines.
 3. Script to archive the logs.
 
 ## Steps to publish (For repo admins)
-```
-npm publish
-```
+
+1. Update sem-ver in `package.json`
+2. `npm publish` (2FA needed)

package/README.md

@@ -1,13 +1,14 @@
 # log-likho
-Our favourite console.log, but on steroids.
+A console.log, that logs on console as well as on a file in `logs/` folder.
+Plus an advance logger with `INFO`, `WARN`, `ERROR` & `FATAL` modes.
 
+### Simple Logger Usage
 
-### Usage
-```
+```sh
 npm install log-likho
 ```
 
-Now at the start of the code let's modify console.log with this steroid version.
+Replace the normal console.log with this "file + console" log function.
 
 ```js
 console.log = require('log-likho')();
@@ -15,9 +16,9 @@ console.log = require('log-likho')();
 console.log('testing 1');
 ```
 
-This should do normal log to console but also write logs real-time to the logs folder
+This should do normal log to console but also write logs real-time to the `logs/` folder
 
-### Log in append mode
+##### Log in append mode
 
 ```js
 console.log = require('log-likho')({mode: 'a'});
@@ -26,25 +27,73 @@ console.log('testing 1');
 ```
 
 
-### With all the options
+##### With all the options
 
 ```js
-const create_logger = require('log-likho');
+const simple_logger = require('log-likho');
 
-console.log = create_logger({
+console.log = simple_logger({
   logs_folder: './my_folder',
   mode: "a",
 })
 
 ```
 
-This will create log files in `my_folder` and will not delete old log for that day but instead append it with new logs.
+This will create log files in `my_folder` and will not overwrite it with new logs on next executions.
+
+
+
+## Advance logger
+
+🚀 Features
+
+    ✅ Supports info, warn, error, fatal, and log levels
+
+    ✅ Colored terminal output for easy debugging
+
+    ✅ Custom log folder and file mode (append/overwrite)
+
+    ✅ No external dependencies
+
+### Usage
+
+```sh
+npm install log-likho
+```
+
+To use the logger. 
+
+```js
+const { create_logger } = require("log-likho");
+
+const logger = create_logger({
+  logs_folder: "./logs", // default: './logs'
+  mode: "a"              // append mode; use 'w' for overwrite
+});
+
+logger.info("This is an info message");
+logger.warn("This is a warning");
+logger.error("This is an error");
+logger.fatal("This is a fatal error");
+logger.log("This is a plain log message");
+```
+
+##### Output
+
+![LoggerImage](./assets/image.png)
 
+| Level | Terminal Color     |
+| ----- | ------------------ |
+| INFO  | Cyan               |
+| WARN  | Yellow             |
+| ERROR | Red                |
+| FATAL | Magenta            |
+| LOG   | Default (no color) |
 
 
 ## Default options
 
-Options | Default Value | Possible values | Purpose
---- | --- | --- | ---
-`logs_folder` | './logs' | any accessible folder | Sets the folder path where the logs will be stored
-`mode` | 'w' | 'a' or 'w' | configures how daily logs are written i.e overwriting mode with 'w' or append mode with 'a' 
+| Option        | Type   | Default  | Description                                            |
+| ------------- | ------ | -------- | ------------------------------------------------------ |
+| `logs_folder` | String | `./logs` | Directory to store log files                           |
+| `mode`        | String | `"a"`    | File write mode: `"a"` for append, `"w"` for overwrite |

package/index.js

@@ -1,3 +1,5 @@
-const create_logger = require('./src/create-logger');
+const simple_logger = require("./src/simple-logger");
+const create_logger = require("./src/logger");
 
-module.exports = create_logger;
+module.exports = simple_logger;
+module.exports.create_logger = create_logger;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "log-likho",
-  "version": "1.2.1",
-  "description": "console.log on steroids",
+  "version": "2.0.1",
+  "description": "A simple file + colored stdout logger for Node.js apps.",
   "main": "index.js",
   "scripts": {
-    "test": "node ./test/default.spec.js && node ./test/options.spec.js"
+    "test": "node ./test/default.spec.js && node ./test/options.spec.js && node ./test/logger.spec.js",
+    "clean": "rm -rf logs simple-logs logger-logs"
   },
   "repository": {
     "type": "git",
@@ -24,7 +25,12 @@
     "logging",
     "one",
     "line",
-    "logger"
+    "logger",
+    "warn",
+    "info",
+    "fatal",
+    "error",
+    "colors"
   ],
   "author": "Neetish Raj",
   "license": "MIT",

package/src/logger.js

@@ -0,0 +1,60 @@
+const fs = require("fs");
+const util = require("util");
+
+const COLORS = require("./utils/colors");
+const default_options = require("./log-options");
+const { dd_month_yyyy_day } = require("./utils/date-formats");
+
+const log_stdout = process.stdout;
+
+const create_logger = (options = {}) => {
+  const final_options = {
+    ...default_options,
+    ...options,
+  };
+
+  const { logs_folder, mode } = final_options;
+
+  if (!fs.existsSync(logs_folder)) {
+    fs.mkdirSync(logs_folder);
+    console.log(`Created '${logs_folder}' folder`);
+  }
+
+  const log_output_path = `${logs_folder}/${dd_month_yyyy_day()}.log`;
+  const log_file = fs.createWriteStream(log_output_path, { flags: mode });
+
+  function formatMessage(level, message) {
+    const timestamp = new Date().toTimeString().substring(0, 8);
+    return `[${timestamp}] [${level}] ${util.format(message)}\n`;
+  }
+
+  return {
+    info: (msg) => {
+      const formatted = formatMessage("INFO", msg);
+      log_file.write(formatted);
+      log_stdout.write(COLORS.INFO + formatted + COLORS.RESET);
+    },
+    warn: (msg) => {
+      const formatted = formatMessage("WARN", msg);
+      log_file.write(formatted);
+      log_stdout.write(COLORS.WARN + formatted + COLORS.RESET);
+    },
+    error: (msg) => {
+      const formatted = formatMessage("ERROR", msg);
+      log_file.write(formatted);
+      log_stdout.write(COLORS.ERROR + formatted + COLORS.RESET);
+    },
+    fatal: (msg) => {
+      const formatted = formatMessage("FATAL", msg);
+      log_file.write(formatted);
+      log_stdout.write(COLORS.FATAL + formatted + COLORS.RESET);
+    },
+    log: (msg) => {
+      const formatted = formatMessage("LOG", msg);
+      log_file.write(formatted);
+      log_stdout.write(formatted);
+    },
+  };
+};
+
+module.exports = create_logger;

package/src/{create-logger.js → simple-logger.js}

@@ -1,18 +1,16 @@
 const fs = require("fs");
 const util = require("util");
 
-const default_options = require('./log-options');
-const { dd_month_yyyy_day } = require('./utils/date-formats');
+const default_options = require("./log-options");
+const { dd_month_yyyy_day } = require("./utils/date-formats");
 
 const log_stdout = process.stdout;
 
-
-const create_logger = (options = {}) => {
-
+const simple_logger = (options = {}) => {
   const final_options = {
     ...default_options,
     ...options,
-  }
+  };
 
   const { logs_folder, mode } = final_options;
 
@@ -35,4 +33,4 @@ const create_logger = (options = {}) => {
   };
 };
 
-module.exports = create_logger;
+module.exports = simple_logger;

package/src/utils/colors.js

@@ -0,0 +1,7 @@
+module.exports = {
+  RESET: "\x1b[0m",
+  INFO: "\x1b[36m",     // Cyan
+  WARN: "\x1b[33m",     // Yellow
+  ERROR: "\x1b[31m",    // Red
+  FATAL: "\x1b[35m"     // Magenta
+};

package/test/logger.spec.js

@@ -0,0 +1,16 @@
+const path = require('path');
+
+const { create_logger } = require('../index');
+
+const logger = create_logger({
+  logs_folder: `${process.cwd()}/logger-logs`,
+  mode: "a" // append mode
+});
+
+console.log("=== Testing log levels ===");
+
+logger.info("This is an info message.");
+logger.warn("This is a warning.");
+logger.error("This is an error.");
+logger.fatal("This is a fatal error.");
+logger.log("This is a generic log.");

package/test/options.spec.js

@@ -1,9 +1,9 @@
-const create_logger = require('../index');
+const simple_logger = require("../index");
 
-console.log = create_logger({
-  logs_folder: `${process.cwd()}/logger`,
+console.log = simple_logger({
+  logs_folder: `${process.cwd()}/simple-logs`,
   mode: "a",
-})
+});
 
 console.log(`testing log in new folder with append mode ${Date.now()}`);
 console.log(`Process ID is : ${process.pid}`);