@vmvaytk/inklog
v1.0.0
Published
A lightweight colorful terminal logger for Node.js and TypeScript applications with automatic text wrapping and clean console formatting.
Downloads
86
Maintainers
Readme
InkLog
A beautiful colorful terminal logger for Node.js and TypeScript applications.
InkLog is a lightweight console logging utility built with TypeScript and Chalk that provides clean, readable, and professional terminal output with automatic text wrapping and colored log formatting.
Perfect for:
- Node.js applications
- TypeScript projects
- CLI tools
- Automation scripts
- Developer utilities
- Terminal dashboards
Features
- Beautiful colorful terminal logs
- Automatic text wrapping
- Clean aligned output formatting
- Success, error, info, and warning logs
- Lightweight and fast
- TypeScript support included
- Zero configuration required
- Developer-friendly API
Installation
npm install @vmvaytk/inklogUsage
Import
import {
successLog,
errorLog,
infoLog,
warningLog
} from "@vmvaytk/inklog"Success Log
successLog("Application started successfully.")Error Log
errorLog("Database connection failed.")Info Log
infoLog("Server is running on port 3000.")Warning Log
warningLog("Memory usage is getting high.")Automatic Text Wrapping
infoLog(
"This is a very long message that automatically wraps while maintaining clean terminal formatting and alignment."
)Example Output
Terminal colors are visible when you run the package inside a real terminal.
Success Log
--------------------------------------------------------------------------------
SUCCESS - Application started successfully.
--------------------------------------------------------------------------------🟢 SUCCESS appears in bright green bold
Error Log
--------------------------------------------------------------------------------
ERROR - Database connection failed.
--------------------------------------------------------------------------------🔴 ERROR appears in bright red bold
Info Log
--------------------------------------------------------------------------------
INFO - Server is running on port 3000.
--------------------------------------------------------------------------------🔵 INFO appears in bright cyan bold
Warning Log
--------------------------------------------------------------------------------
WARNING - Memory usage is getting high.
--------------------------------------------------------------------------------🟡 WARNING appears in bright yellow bold
API Reference
successLog(message?)
Displays a green success message.
Default message:
"Operation completed successfully."errorLog(message?)
Displays a red error message.
Default message:
"Something went wrong during execution."infoLog(message?)
Displays a cyan informational message.
Default message:
"Just a heads up."warningLog(message?)
Displays a yellow warning message.
Default message:
"Potential issue identified"Why InkLog?
Most logging libraries are either too complex, too heavy, or require extensive configuration.
InkLog focuses on:
- simplicity,
- readability,
- lightweight performance,
- clean developer experience,
- and professional terminal output.
Built With
- TypeScript
- Chalk
- Node.js
Development
Clone the repository:
git clone https://github.com/your-username/inklog.gitInstall dependencies:
npm installRun development server:
npm run devBuild the project:
npm run buildStart production build:
npm startSEO Keywords
terminal logger, nodejs logger, typescript logger, chalk logger, colorful console logger, terminal utility, cli logger, lightweight logger, console formatter, node terminal logs
License
ISC
