Skip to content

A lightweight logger, console text colorizer and text formatter with highest formatting options.

License

Notifications You must be signed in to change notification settings

FantoX/xtra-logger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

xtra-logger logo

XTRA-LOGGER

A lightweight logger, console text coloriser and text formatter with highest formatting options written in Typescript


Compatibility:

Version Compatibility
Es5 Javascript
Es6 Javascript
Typescript

Features:

Feature Availability
Logging
Text Formatting
Console Colorize
Combined Formatting
Size
17 kb

Installation:

Node Package Manager (NPM)

npm i xtra-logger

Yet Another Resource Navigator (YARN)

yarn add xtra-logger

Importing:

For Es5 Js

const { logger, format } = require("xtra-logger");

For Es6 Js / Typescript

import { logger, format } from "xtra-logger";

Usage Examples:

Logging features:

  • 5 Log methods available ( info, warn, success, warn, error )
  • Changable timezome for Docker / Remote servers ( Search your time zome name from here. )
  • Log format : [ DD.MM.YY - HH:MM:SS ] - [ TYPE ] - MESSAGE

Example :

import { logger, format } from "xtra-logger";

// Changing the timezone of logger [ optional ] (By default it will use system time)
logger.timeZone("Asia/Kolkata");

// Logging options
logger.info("Starting the server...");
logger.warn("Using node v:18.6");
logger.success("Server started successfully.");
logger.debug("NPM update available.");
logger.error("An error occurd in the server.");

Output :

Formatting example output

Text formatting features:

  • 50+ text formatting / colorizing options available.
  • Multiple formatting can be combined together to create new style.

Example :

import { logger, format } from "xtra-logger";

// Only bold text
console.log(format.bold("This is a Bold text\n"));

// Combining colours + multiple formatting
console.log(
  format.bold(
    format.italic(format.cyan("This is a Bold + Italic + Cyan colour text \n"))
  )
);

console.log(
  format.bgBrightmagenta(
    format.strikethrough(
      format.lightwhite(
        "This is a strikethrough + light white text with bright magenta background"
      )
    )
  )
);

Output :

Formatting example output

Contributing:

I don't have any contributors in this project yet. Feel free to contribute and making it better.