@xorgal/logger

Logger

Logger is a simple and flexible, customizable logging utility for JavaScript applications.

Features

• Severity Levels: Log messages at different severity levels such as debug, info, warn and error.
• Timestamps: Each log message can optionally be prefixed with a timestamp.
• Log Levels: You can specify a log level to filter out log messages below a certain severity.
• Customizable Formatting: Use the 'align' parameter to format log messages. Add colors to the log level label with the 'colorize' option.
• Easy to Use: Simply import the Logger class and create a new logger with your desired settings.

Installation

To install Logger, you can use npm, yarn or pnpm:

npm install @xorgal/logger

with yarn

yarn add @xorgal/logger

with pnpm

pnpm add @xorgal/logger

Usage

Creating a logger and logging a message:

import { Logger, LogLevel } from '@xorgal/logger';

Set minimum log level:

const log = new Logger({ level: LogLevel.info });
log.info('Hello, Logger!');

Configuration:

const isDevelopment = process.env.NODE_ENV === 'development' ? true : false;

const log = new Logger({
  timestamp: true,
  level: isDevelopment ? LogLevel.debug : LogLevel.info,
  includeLevel: true,
  colorize: true,
  align: true,
});

log.debug('This is debug message.');

// Output:
// 2023-09-29T10:57:24.803Z [debug] This is debug message.

Log levels:

enum LogLevel {
    debug = 0,
    info = 1,
    warn = 2,
    error = 3
}

License

Logger is licensed under the MIT license. See the LICENSE file for more info.