🪵 Loggerts

A lightweight and colorful logging library for TypeScript / Node / Bun projects.
Provides a simple and modern API for logging to both the console and files.

📦 Installation

Using npm:

npm install @neelfrostrain/loggerts

Using bun:

bun add @neelfrostrain/loggerts

🚀 Quick Start

import { Logger, Log } from "@neelfrostrain/loggerts";

// Initialize logger (creates "Logs/main.log" in the given directory)
Logger.Init("./");

// Log a simple message
Logger.Log("Application started successfully!");

// Log with parameters
Logger.Warn("Disk usage is high:", { used: "92%" });
Logger.Error("Failed to connect to database", new Error("ConnectionTimeout"));
Logger.Debug("Debug info:", { user: "admin", id: 42 });

// Quick one-liner log (console only)
Log({ msg: "Hello from Loggerts!" });

Output example:

[2025-10-08 18:42:17.024] [LOG] > Application started successfully!
[2025-10-08 18:42:17.030] [WARN] > Disk usage is high: { used: "92%" }
[2025-10-08 18:42:17.036] [ERROR] > Failed to connect to database Error: ConnectionTimeout
[2025-10-08 18:42:17.042] [DEBUG] > Debug info: { user: "admin", id: 42 }

All messages are written to:

<your path>/Logs/main.log

🧠 API Reference

Logger.Init(path: string): void

Initializes the logger and creates a Logs/main.log file in the given path.

⚠️ Must be called before any logging methods.

Logger.Log(msg: string, ...params: unknown[]): void

Logs general information (green).

Logger.Warn(msg: string, ...params: unknown[]): void

Logs warnings (yellow).

Logger.Error(msg: string, ...params: unknown[]): void

Logs errors (red).

Logger.Debug(msg: string, ...params: unknown[]): void

Logs debug information (cyan).

Log({ msg: string }): void

A simple one-shot console log — does not write to file.

⚙️ Example Output Folder Structure

project/
├── src/
│   └── index.ts
├── Logs/
│   └── main.log
└── package.json

🧩 TypeScript Support

This package ships with built-in .d.ts type declarations —
so you get full IntelliSense and autocomplete support out of the box.

🪪 License

MIT License

Copyright (c) 2025 Neel Frostrain

💬 Author

Developed with ❤️ by Neel Frostrain
For feedback or feature requests — open an issue on GitHub.