mojilogger v1.1.3

mojilogger

Console logs tagged with a unique emoji based on any identifiers to easily distinguish between identical log sources.

🔷 Typescript ready ✅ Wrapper over console.log

Installation

npm:

npm install mojilogger

or with yarn:

yarn add mojilogger

Usage

Basic Usage

Import the mojilogger:

import { mojilogger } from 'mojilogger';

const { mojilogger } = require('mojilogger');

Log a message with an id:

mojilogger.withId('API').log('Fetching data...');
// Console Output: 🌟 Fetching data...

Log a message without id:

This will use the 💬, if this is taken it will use another one from the list or generate an unused one

mojilogger.log('Hello World!');
// Console Output: 💬 Hello World!

Log multiple messages with different ids:

mojilogger.withId('API').log('Fetching data...');
mojilogger.withId('DB').log('Fetching data...');
mojilogger.withId('API').log('Data received...');
mojilogger.withId('DB').log('Data received...');
// Console Output: 🌟 Fetching data...
// Console Output: 💧 Fetching data...
// Console Output: 🌟 Data received...
// Console Output: 💧 Data received...

Assign a custom emoji for specific id:

mojilogger.withId('API','👽').log('Fetching data...');
mojilogger.withId('DB').log('Fetching data...');
mojilogger.withId('API').log('Data received...');
mojilogger.withId('DB').log('Data received...');
// Console Output: 👽 Fetching data...
// Console Output: 💧 Fetching data...
// Console Output: 👽 Data received...
// Console Output: 💧 Data received...

To get the map of identifiers to emojis:

const map = mojilogger.getMojiMap();
console.log(map);

You can use existing console log functionalities:

const data = 20;
mojilogger.withId('DB').log('Fetching data...', data);
// Console Output: 🌟 Fetching data... 20

Custom Emoji List

The default emoji list starts with the star emoji "🌟" and is as follows:

"🌟", "💧", "❤️", "🚗", "🎵", "⏰", "🔑",
"🎈", "📘", "⚽", "✈️", "🚢", "⚡", "🍎",
"☎️", "📺", "💡", "🔔", "⚓", "📷", "🎉",
"🏠", "⛅", "🌈", "🔒", "🛒", "🎨", "⛵",
"💼", "🎭", "🕰️", "🧲", "🎻", "🏰", "🌵",
"🌶️", "📌", "🔍", "⚖️", "⛔", "🚸", "📵",
"🔞", "🛑", "🛠️", "🎖️", "🚫", "🔴", "🟠",
"🟡", "🟢", "🟣", "🟤", "⚫", "❗", "❓",
"🔶", "🟥", "🟧", "🟨", "🟩", "🟪", "🎲",
"🍀", "🎳", "🔕", "📬", "🪁", "🔭"

After 🔭, the logger will generate unused emojis until it reaches out of unique ones. Will assign o🚫o to all other ids when it runs out of emojis. (More precise after 1778 emojis are used)

You can set a custom emoji list for new identifiers:

mojilogger.setMojiList(['😄','🌈','🚀']);
mojilogger.withId('API').log('Fetching data...');
// Console Output: 😄 Fetching data...

To retrieve the emoji list being used:

const list = mojilogger.getMojiList();
console.log(list);

Second Id level scoping

You can use a second level color scoping:

const data = 20;
mojilogger.withId('DB').withId('MYSQL').log('Fetching data...', data);
// Console Output: 🌟 Fetching data... 20

🌟 Fetching data... 20

You can use a custom color:

const data = 20;
mojilogger.withId('DB').withId('MYSQL', '#333').log('Fetching data...', data);
// Console Output: 🌟 Fetching data... 20

🌟 Fetching data... 20

To retrieve the color list being used:

const list = mojilogger.getColorList();
console.log(list);

You can set a custom color list for new identifiers:

mojilogger.setColorList(['#802080','#222','#333']);
mojilogger.withId('API').withId('CDN').log('Fetching data...');
// Console Output: 🌟 Fetching data...

🌟 Fetching data... 20

Resetting the Logger

To reset all mappings and restore to default state:

mojilogger.resetAll();

❗❗❗ Caution: Be careful with memory leaks. This package stores each ID in memory to map it to an emoji. Therefore, it's advisable to use this package only in development environments.

Creative usages

store the logger after scoping it with an id:

import { mojilogger, type MojiLog } from 'mojilogger';
class Service {
  private readonly logger: MojiLog;
  constructor() {
    this.logger = mojilogger.withId(this);
    this.logger.log('Hello from this service');
  }
}

const serviceOne = new Service();
const serviceTwo = new Service();
// Console Output: 🌟 Hello from this service
// Console Output: 💧 Hello from this service

extend / modify the default moji list:

const list = mojilogger.getMojiList();
mojilogger.setMojiList(['😄', ...list]);
mojilogger.withId('API').log('Fetching data...');
mojilogger.withId('DB').log('Fetching data...');
// Console Output: 😄 Fetching data...
// Console Output: 🌟 Fetching data...

License

This project is licensed under the MIT License - see the LICENSE.md file for details.