npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rabbit-company/logger

v4.0.0

Published

Simple logger

Downloads

7

Readme

Logger-JS

Logger-JS is a lightweight logging utility for JavaScript (ES6) that provides various logging levels and supports NDJson formatting for structured logging.

Table of Contents

  1. Installation
  2. Importing the Library
  3. Configuration
  4. Logging Messages
  5. NDJson Logging
  6. Customization

Installation

To install Logger-JS, use npm to add it to your project:

npm i --save @rabbit-company/logger

Importing the Library

After installation, you can import the Logger into your JavaScript file:

import Logger from "@rabbit-company/logger";

Configuration

Configure the logger to suit your needs. You can set the log level to control which types of messages are logged:

// Set the log level to SILLY to enable all levels of logging
Logger.level = Logger.Levels.SILLY;

// Enable or disable colored output
Logger.colors = true; // Set to false to disable colors

// Enable or disable NDJson logging
Logger.NDJson = false; // Set to true to enable NDJson logging

Logging Messages

Use the provided methods to log messages at different levels of severity:

// Log an error message
Logger.error("This is an error message.");

// Log a warning message
Logger.warn("This is a warning message.");

// Log an informational message
Logger.info("This is an informational message.");

// Log an HTTP-related message
Logger.http("This is an HTTP-related message.");

// Log a verbose message
Logger.verbose("This is a verbose message.");

// Log a debug message
Logger.debug("This is a debug message.");

// Log a silly message
Logger.silly("This is a silly message.");

NDJson Logging

When NDJson logging is enabled, log messages are formatted as newline-delimited JSON. You can retrieve the NDJson formatted log using:

// Enable NDJson logging
Logger.NDJson = true;

// Retrieve NDJson log data
const ndjsonLog = Logger.getNDJson();
console.log(ndjsonLog);

// Clear NDJson log data
Logger.resetNDJson();

Customization

1. Customizing Log Colors

You can customize the colors associated with different logging levels by modifying the LevelColors mapping:

// Change colors for different log levels
Logger.LevelColors[Logger.Levels.ERROR] = Logger.Colors.BRIGHT_RED;
Logger.LevelColors[Logger.Levels.INFO] = Logger.Colors.GREEN;

2. Customizing Log Message Format

You can also customize the format of the log messages by setting the Logger.format string. This format string can include the following placeholders:

  • {date}: Inserts the current timestamp.
  • {type}: Inserts the log level type (e.g., ERROR, INFO).
  • {message}: Inserts the actual log message.

Example of customizing the log format:

// Set a custom log message format
Logger.format = "[{date}] - {type}: {message}";