Logger

Simple Node.js logger with colors, file logging, and caller tracking.

Install

@samiul-npm-developer/logger

Simple, production-ready logger for Node.js applications — lightweight, file-backed, and colorized for console output.

Table of Contents

• Installation
• Quick Start
• API
• Log File
• Behavior
• Contributing
• License

Installation

Install from npm:

npm install @samiul-npm-developer/logger

Or install locally and require the package from your project.

Quick Start

Require and use the logger object. The package uses CommonJS exports.

const { logger } = require('@samiul-npm-developer/logger');

logger.info('Server started');
logger.success({ event: 'user.signup', userId: 123 });
logger.warn('Cache miss for key: users:123');
logger.error(new Error('Database connection failed'));

If you're requiring from a local copy during development, use:

const { logger } = require('./path/to/logger');

API

• logger.info(msg) — Informational messages.
• logger.success(msg) — Success/ok messages.
• logger.warn(msg) — Warning messages.
• logger.error(msg) — Error messages (accepts Error objects).

Each method accepts a string, an object (which will be JSON-stringified), or an Error instance.

Log File

By default the logger writes persistent logs to a logs/app.log file in your process working directory. The logger will create the logs directory automatically when first used and appends newline-delimited JSON records to app.log.

Each log entry is a single-line JSON object with these fields:

• timestamp — ISO timestamp
• level — log level (INFO, SUCCESS, WARN, ERROR)
• file — the relative file path of the caller (best-effort)
• message — string or JSON payload

Behavior

• Console output is colorized for readability in terminals.
• The library uses a write stream to append logs and gracefully closes the stream on process exit and common termination signals.
• Designed for CommonJS (type: commonjs) Node.js projects.

Contributing

Issues and pull requests are welcome. Keep changes focused and include tests or usage examples when possible.

Author

MD Samiul Islam

License

MIT