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

cat-loggr

v1.2.2

Published

A utility to make beautiful console logs easily.

Downloads

2,258

Readme

Cat Loggr

npm

A simple, lightweight utility for making beautiful logs.

Goals

  1. Be lightweight
  2. Be a drop-in replacement for console.log
  3. Generate pretty, colourful logs
  4. Support sharded projects (via a shard ID)
  5. Support parsing of multiple arguments, including the inspecting of objects
  6. Support defining display options at execution

Screenshots

blargbot logs

Installation

npm i --save cat-loggr

Basic Usage

// JavaScript:
const CatLoggr = require('cat-loggr');
// TypeScript:
import CatLoggr from 'cat-loggr/ts';

const loggr = new CatLoggr();

loggr.log('Hello, world!');

That's it!

Default Log Levels

  • fatal
  • error
  • warn
  • trace
  • init
  • info
  • verbose
  • debug (aliases: log, dir)

If defined, the info level is default. If not, the lowest priority level is default.

More Advanced Usage

Custom levels

const loggr = new CatLoggr({
    levels: [
        { name: 'catnip', color: CatLoggr._chalk.red.bgBlack },
        { name: 'fish', color: CatLoggr._chalk.black.bgRed }
    ]
});
// OR
const loggr = new CatLoggr()
    .setLevels([
        { name: 'catnip', color: CatLoggr._chalk.red.bgBlack },
        { name: 'fish', color: CatLoggr._chalk.black.bgRed }
    ]);

loggr.fish('Delicious!');

Level threshold

const loggr = new CatLoggr({
    level: 'warn'
});
// OR
const loggr = new CatLoggr()
    .setLevel('warn');

loggr.info('This will not display,');
loggr.warn('but this will!');

Meta

  • depth - how far into an object to inspect
  • color - whether to render colors
  • trace - whether to generate a stacktrace
const loggr = new CatLoggr();

let obj = {
    with: {
        depth: {
            fun: '!'
        }
    }
};

loggr.log(obj);
// { with: { depth: [Object] } }
loggr.meta({depth: 2}).log(obj);
// { with: { depth: { fun: '!' } } }

Hooks

You can define hook for extra argument processing.

If the hook callback returns null or undefined, the processing for that argument will continue. Otherwise, it will cease if an actual value is returned.

Returned values will be added to the log's output. If an array is returned, each element of the array will be added individually.

class Cat {}
const cat = new Cat();

const loggr = new CatLoggr()
    .addArgHook(function({ arg, date }) {
        if (arg instanceof Cat)
            return 'kitty!';
    });

loggr.log(cat);
// kitty!

You can also define hooks for post processing.

const loggr = new CatLoggr()
    .addPostHook(function({ text }) {
        return 'Hello, ' + text; 
    });

loggr.log('world!');
// Hello, world!

Global

If you want to go full meme, you can make CatLoggr overwrite the global console object! Use responsibly.

const loggr = new CatLoggr()
    .setGlobal();

console.log('Hello, world!');