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

@autometa/logging

v0.0.2

Published

This package provides a `GroupLogger` class which enables `console.group` like behavior. Useful for debugging, or when tests will be run consecutively [see Async](#async).

Downloads

6

Readme

Logging & Console

This package provides a GroupLogger class which enables console.group like behavior. Useful for debugging, or when tests will be run consecutively see Async.

The console module can also be overwritten to use GroupLogger internally and reenable console groups (which are disabled in node due to its Async nature) globally in your project.

Grouping can be enabled by calling useConsoleGroups, and disabled with disableConsoleGroups.

To start a console group call console.group('some title here'), and to end it call console.groupEnd().

For example take the following code:

const logger = new GroupLogger()
logger.group('Outer Group');
logger.group('Inner Group');
logger.log('Http Request Sent');
logger.log('Http Response Received');  
logger.groupEnd();
logger.groupEnd();

or with console groups enabled

console.group('Outer Group');
console.group('Inner Group');
console.log('Http Request Sent');
console.log('Http Response Received');  
console.groupEnd();
console.groupEnd();

Which will produce the following output

Outer Group
  Inner Group
     [Log]
     Http Request Sent
     /path/to/file:8:11

     [Log]
     Http Response Received
     /path/to/file:9:11

Checked Grouping

To confirm groups are being ended when expected, the startGroup and endGroup functions can be used.

startGroup takes a ConsoleGroupToken or a string and begins a console group. endGroup also takes a ConsoleGroupToken or a string, and will raise a warning message if groups are being ended in the wrong order.

ConsoleGroupToken

The ConsoleGroupToken is an empty enum. It can be replaced by custom enum values by declaring the type somewhere in your project.

// in 'typings.d.ts' or similar file
declare module "@autometa/logging" {
    export enum ConsoleGroupToken {
        Scenario = 'Scenario',
        Test = 'Test'
    }
}

Which can now be used directly

startGroup(ConsoleGroupToken.Scenario)

startGroup can also accept additional values which will be displayed in the group title

startGroup(ConsoleGroupToken.Scenario, 'first', 1)
// prints 
// Scenario: first, 1

Grouping

Alternatively the grouping function can be used. grouping takes a title and an action. The action is executed and the group is closed again before the error is propagated.

Grouping will return the value of an action directly. If the action returns a promise, then grouping can be awaited

grouping('a group', ()=>{
    doStuff()
})

await grouping('an async group', async ()=>{
    return someAsyncJob()
})

Async

Grouping only makes sense in a synchronous context. Groups should only be written outside of async functions which are not immediately awaited.

However async actions can be run within a group - just be sure they're all completed before ending it.