hb-smart-logger 1.0.0

package/README.md

@@ -0,0 +1,142 @@
+HB Smart Logger 🚀
+
+HB Smart Logger is a production-ready logging solution for Node.js built on top of Winston, designed to be simple to use, safe by default, and scalable for real-world applications.
+
+It works out of the box with zero configuration, yet provides advanced features like daily log rotation, safe JSON logging, and structured multi-argument logging.
+
+✨ Key Benefits
+
+✅ Zero-Config Setup
+Just install and start logging — no boilerplate required.
+
+✅ Safe Object Logging
+Handles circular JSON safely (no crashes, no [object Object]).
+
+✅ Daily Log Rotation
+Automatically rotates logs by day and size, with compression and retention.
+
+✅ Separate & Combined Logs
+Keeps per-level logs (error, warn, info, debug) and a full combined log.
+
+✅ Multi-Argument Support
+Log multiple values like console.log() — strings, objects, and errors.
+
+✅ logger.log() Alias
+Drop-in replacement for console.log() — routes to info level internally.
+
+✅ Error Stack Traces Included
+Errors automatically log full stack traces.
+
+✅ Production-Ready Defaults
+Designed for APIs, microservices, background workers, and cron jobs.
+
+📦 Installation
+npm install hb-smart-logger
+
+🚀 Quick Start
+const logger = require("hb-smart-logger");
+
+logger.log("Application started");
+logger.info("Server listening", { port: 3000 });
+logger.warn("Slow response", { endpoint: "/users", timeMs: 1420 });
+logger.error("Database connection failed", new Error("ECONNREFUSED"));
+
+🧠 Smart Logging Examples
+Log multiple arguments (like console.log)
+logger.log("User login", userId, { role: "admin" });
+
+Log objects safely (no crashes)
+const obj = {};
+obj.self = obj;
+
+logger.info("Circular object test", obj);
+
+Log errors with stack trace
+try {
+  throw new Error("Something went wrong");
+} catch (err) {
+  logger.error("Unhandled error", err);
+}
+
+📁 Log Output Structure
+
+HB Smart Logger automatically creates this structure:
+
+logs/
+  combined/
+    combined-2026-01-05.log
+  error/
+    error-2026-01-05.log
+  warn/
+    warn-2026-01-05.log
+  info/
+    info-2026-01-05.log
+  debug/
+    debug-2026-01-05.log
+
+What goes where?
+Log Level	File
+log() / info()	logs/info/ + logs/combined/
+warn()	logs/warn/ + logs/combined/
+error()	logs/error/ + logs/combined/
+debug()	logs/debug/ + logs/combined/
+🔄 Log Rotation (Built-In)
+
+📅 Daily rotation
+
+📦 Max size: 10 MB per file
+
+🗜️ Compressed archives
+
+🧹 Auto-cleanup: keeps last 30 days
+
+No extra setup required.
+
+🧪 Environment Friendly
+
+Works in development, staging, and production
+
+Colorized console output for local development
+
+File-based logging for production systems
+
+🛠️ Use Cases
+
+✔ REST APIs
+✔ Express / Fastify servers
+✔ Background workers
+✔ Cron jobs
+✔ Microservices
+✔ Serverless (file logging disabled environments excluded)
+
+🔥 Why HB Smart Logger?
+Feature	console.log	Winston HB Smart Logger
+Daily rotation	❌	❌	✅
+Circular JSON safe	❌	❌	✅
+Per-level files	❌	⚠️	✅
+Combined logs	❌	⚠️	✅
+logger.log() alias	❌	❌	✅
+Ready-to-use	❌	⚠️	✅
+📌 Requirements
+
+Node.js >= 14
+
+CommonJS environment
+
+🧭 Roadmap
+
+Planned enhancements:
+
+Configurable log directory
+
+JSON-only output mode
+
+Express request/response middleware
+
+TypeScript typings
+
+Cloud logging support (AWS / GCP)
+
+📄 License
+
+MIT © 2026 Hafiz Bilal

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "hb-smart-logger",
+  "version": "1.0.0",
+  "description": "Production-ready Winston logger with daily rotation, safe JSON handling, and logger.log() alias",
+  "main": "src/index.js",
+  "publishConfig": { "access": "public" },
+  "keywords": [
+    "logger",
+    "winston",
+    "logging",
+    "daily-rotate",
+    "nodejs",
+    "express"
+  ],
+  "author": "Hafiz Bilal",
+  "license": "MIT",
+  "dependencies": {
+    "winston": "^3.13.0",
+    "winston-daily-rotate-file": "^5.0.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,141 @@
+const fs = require("fs");
+const path = require("path");
+const winston = require("winston");
+const DailyRotateFile = require("winston-daily-rotate-file");
+
+// Ensure logs directory exists
+const logDir = path.resolve("logs");
+
+const subDirs = ["combined", "error", "warn", "info", "debug"];
+subDirs.forEach((dir) => {
+  const fullPath = path.join(logDir, dir);
+  if (!fs.existsSync(fullPath)) {
+    fs.mkdirSync(fullPath, { recursive: true });
+  }
+});
+
+/* ---------------------------------------------------
+   SAFE STRINGIFY
+--------------------------------------------------- */
+function safeStringify(obj) {
+  const seen = new WeakSet();
+  return JSON.stringify(
+    obj,
+    (key, value) => {
+      if (typeof value === "object" && value !== null) {
+        if (seen.has(value)) return "[Circular]";
+        seen.add(value);
+      }
+      return value;
+    },
+    2
+  );
+}
+
+/* ---------------------------------------------------
+   FORMATTER
+--------------------------------------------------- */
+const logFormat = winston.format.printf(
+  ({ level, message, timestamp, stack, ...meta }) => {
+    let msg = message;
+
+    if (typeof msg === "object") {
+      msg = safeStringify(msg);
+    }
+
+    const metaString =
+      Object.keys(meta).length ? " " + safeStringify(meta) : "";
+
+    return `${timestamp} [${level.toUpperCase()}]: ${
+      stack || msg
+    }${metaString}`;
+  }
+);
+
+/* ---------------------------------------------------
+   BASE LOGGER
+--------------------------------------------------- */
+const baseLogger = winston.createLogger({
+  level: "info",
+  format: winston.format.combine(
+    winston.format.timestamp({ format: "YYYY-MM-DD HH:mm:ss" }),
+    winston.format.errors({ stack: true }),
+    logFormat
+  ),
+  transports: [],
+});
+
+/* ---------------------------------------------------
+   ROTATING FILES
+--------------------------------------------------- */
+
+// Combined logs (ALL levels)
+baseLogger.add(
+  new DailyRotateFile({
+    dirname: path.join(logDir, "combined"),
+    filename: "combined-%DATE%.log",
+    datePattern: "YYYY-MM-DD",
+    zippedArchive: true,
+    maxSize: "10m",
+    maxFiles: "30d",
+  })
+);
+
+// Per-level logs
+["error", "warn", "info", "debug"].forEach((level) => {
+  baseLogger.add(
+    new DailyRotateFile({
+      dirname: path.join(logDir, level),
+      filename: `${level}-%DATE%.log`,
+      level,
+      datePattern: "YYYY-MM-DD",
+      zippedArchive: true,
+      maxSize: "10m",
+      maxFiles: "30d",
+    })
+  );
+});
+
+// Console output
+baseLogger.add(
+  new winston.transports.Console({
+    format: winston.format.combine(
+      winston.format.colorize(),
+      winston.format.simple()
+    ),
+  })
+);
+
+/* ---------------------------------------------------
+   WRAPPER (MULTI-ARGS + logger.log)
+--------------------------------------------------- */
+const wrapLogger = (logger) => {
+  const levels = ["info", "warn", "error", "debug"];
+
+  for (const level of levels) {
+    const original = logger[level].bind(logger);
+
+    logger[level] = (...args) => {
+      const merged = args
+        .map((arg) => {
+          if (arg instanceof Error) {
+            return `${arg.message}\n${arg.stack}`;
+          }
+          if (typeof arg === "object") {
+            return safeStringify(arg);
+          }
+          return String(arg);
+        })
+        .join(" ");
+
+      return original(merged);
+    };
+  }
+
+  // Alias: logger.log() → logger.info()
+  logger.log = (...args) => logger.info(...args);
+
+  return logger;
+};
+
+module.exports = wrapLogger(baseLogger);