chalk-box-logger
v1.0.1
Published
A colorful boxed logger for Node.js and CLI apps using chalk with fixed-width formatting
Downloads
13
Maintainers
Readme
🎨 Chalk Box Logger
A colorful, boxed logger for Node.js using chalk.
It prints clean, fixed-width log boxes with automatic word wrapping — perfect for CLIs, scripts, and backend logs.
✨ Features
- ✅ Color-coded log levels
- 📦 Boxed & fixed-width layout
- 🧠 Automatic text wrapping
- 🚀 Lightweight & fast
- 🌈 Powered by Chalk
- 📜 Simple API
📦 Installation
npm install chalk-box-logger
# or
yarn add chalk-box-logger
Requires Node.js v18+
🚀 Usage
import {
successLog,
errorLog,
warningLog,
infoLog
} from "chalk-box-logger"
successLog("Operation completed successfully")
errorLog("Something went wrong during execution")
warningLog("This action may have side effects")
infoLog("Server started on port 3000")
🖨 Example Output
--------------------------------------------------------------------------------
SUCCESS - Operation completed successfully
--------------------------------------------------------------------------------
Each log level has its own color:
🟢 SUCCESS – Green
🔴 ERROR – Red
🟡 WARNING – Yellow
🔵 INFO – Cyan
📚 API Reference
successLog(message?: string)
Logs a success message.
errorLog(message?: string)
Logs an error message.
warningLog(message?: string)
Logs a warning message.
infoLog(message?: string)
Logs an informational message.
All functions accept an optional string message.
⚙️ Configuration
Currently, the logger uses:
Fixed width: 80 characters
Predefined colors per log type
(Custom width & themes coming soon 👀)
🛠 Built With
chalk
TypeScript
📄 License
MIT © MD Ajhar Alam
🤝 Contributing
Contributions are welcome!
Feel free to open issues or submit pull requests.
⭐ Support
If you find this package useful, please consider starring it on npm or GitHub ⭐
---
## ✅ Next recommended steps
If you want, I can:
- Add **CLI support** (`npx chalk-box-logger success "Done"`)
- Add **CommonJS support**
- Add **custom width & themes**
- Generate a **logo + npm banner**
- Write a **CHANGELOG**
Just tell me what you want next 🚀
