@gibme/logger

A simple Winston wrapper that provides a pre-configured singleton logger with console and file transports.

Features

• Console transport with colorized output, enabled by default
• Debug-level console output automatically enabled when NODE_ENV !== 'production'
• Optional file transport with configurable path and filename
• Additional log files via addLog()
• Full access to underlying Winston format, transports, and Winston exports for advanced use

Installation

yarn add @gibme/logger
Copy

or

npm install @gibme/logger
Copy

Quick Start

import Logger from '@gibme/logger';

Logger.info('Application started');
Logger.debug('Debug details here');
Logger.warn('Something looks off');
Logger.error('Something went wrong');
Copy

File Logging

File logging is disabled by default. Enable it at runtime or via environment variable:

// Enable the default file transport at runtime
Logger.enableDefaultLog();

// Disable it again
Logger.disableDefaultLog();
Copy

Adding Additional Log Files

// Add a custom log file with a specific level
Logger.addLog('errors.log', 'error');

// Specify a custom path
Logger.addLog('audit.log', 'info', '/var/log/myapp');
Copy

Environment Variables

Configuration is handled through environment variables (with dotenv support):

Variable	Default	Description
NODE_ENV	—	When set to production, console output is limited to info level and above
ENABLE_DEFAULT_LOG	false	Set to true to enable the default file transport on startup
LOG_PATH	./logs/	Directory for log files
LOG_FILENAME	info.log	Filename for the default file transport
LOG_CREATE_PATH	true	Set to false to skip automatic creation of the log directory

Properties

Property	Type	Description
Logger.path	string	The resolved default log directory path
Logger.defaultFilename	string	The default log filename
Logger.defaultFilenamePath	string	The full resolved path to the default log file

Exports

The package re-exports Winston internals for advanced configuration:

import Logger, { Winston, transports, format } from '@gibme/logger';
Copy

Documentation

Full API documentation is available at https://gibme-npm.github.io/logger/.

License

MIT - see LICENSE for details.