hb-smart-logger 1.0.0 → 1.0.1

package/README.md

@@ -1,67 +1,78 @@
-HB Smart Logger 🚀
+# 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.
+**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.
+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.
+## ✨ Key Benefits
 
-✅ Safe Object Logging
-Handles circular JSON safely (no crashes, no [object Object]).
+- ✅ **Zero-Config Setup**  
+  Just install and start logging — no boilerplate required.
 
-✅ Daily Log Rotation
-Automatically rotates logs by day and size, with compression and retention.
+- ✅ **Safe Object Logging**  
+  Handles **circular JSON** safely (no crashes, no `[object Object]`).
 
-✅ Separate & Combined Logs
-Keeps per-level logs (error, warn, info, debug) and a full combined log.
+- ✅ **Daily Log Rotation**  
+  Automatically rotates logs by day and size, with compression and retention.
 
-✅ Multi-Argument Support
-Log multiple values like console.log() — strings, objects, and errors.
+- ✅ **Separate & Combined Logs**  
+  Keeps **per-level logs** (`error`, `warn`, `info`, `debug`) **and** a full **combined log**.
 
-✅ logger.log() Alias
-Drop-in replacement for console.log() — routes to info level internally.
+- ✅ **Multi-Argument Support**  
+  Log multiple values like `console.log()` — strings, objects, and errors.
 
-✅ Error Stack Traces Included
-Errors automatically log full stack traces.
+- ✅ **`logger.log()` Alias**  
+  Drop-in replacement for `console.log()` — routes to `info` level internally.
 
-✅ Production-Ready Defaults
-Designed for APIs, microservices, background workers, and cron jobs.
+- ✅ **Error Stack Traces Included**  
+  Errors automatically log full stack traces.
 
-📦 Installation
-npm install hb-smart-logger
+- ✅ **Production-Ready Defaults**  
+  Designed for APIs, microservices, background workers, and cron jobs.
+
+---
 
-🚀 Quick Start
+## 📦 Installation
+
+```bash
+npm install hb-smart-logger
+```
+## 🚀 Quick Start
+```bash
 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
+```
+## 🧠 Smart Logging Examples
 Log multiple arguments (like console.log)
+```bash
 logger.log("User login", userId, { role: "admin" });
+```
 
 Log objects safely (no crashes)
+```bash
 const obj = {};
 obj.self = obj;
-
 logger.info("Circular object test", obj);
-
+```
 Log errors with stack trace
+```bash
 try {
   throw new Error("Something went wrong");
 } catch (err) {
   logger.error("Unhandled error", err);
 }
+```
 
-📁 Log Output Structure
+## 📁 Log Output Structure
 
 HB Smart Logger automatically creates this structure:
-
+```bash
 logs/
   combined/
     combined-2026-01-05.log
@@ -73,14 +84,21 @@ logs/
     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)
+## 📂 What Goes Where?
+
+## Log Level	## Files Written
+**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
 
@@ -92,7 +110,7 @@ debug()	logs/debug/ + logs/combined/
 
 No extra setup required.
 
-🧪 Environment Friendly
+## 🧪 Environment Friendly
 
 Works in development, staging, and production
 
@@ -100,30 +118,36 @@ Colorized console output for local development
 
 File-based logging for production systems
 
-🛠️ Use Cases
+## 🛠️ 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
+✔ Long-running Node.js services
+
+## 🔥 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
+
+## 📌 Requirements
 
 Node.js >= 14
 
 CommonJS environment
 
-🧭 Roadmap
+## 🧭 Roadmap
 
 Planned enhancements:
 
@@ -137,6 +161,6 @@ TypeScript typings
 
 Cloud logging support (AWS / GCP)
 
-📄 License
+## 📄 License
 
-MIT © 2026 Hafiz Bilal
+MIT © 2026 Hafiz Bilal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hb-smart-logger",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Production-ready Winston logger with daily rotation, safe JSON handling, and logger.log() alias",
   "main": "src/index.js",
   "publishConfig": { "access": "public" },