debug-symbols
v1.0.2
Published
Combines the popular debug module and log-symbols to create colorized debug logs with matching symbols
Downloads
27
Maintainers
Readme
Motivation
I built this small module because I wanted to use the popular debug module but extend it to:
- Handle different log levels out of the box
- Use colorization for different log levels (using chalk )
- Add the amazing log-symbols symbols to logs.
Usage
This module merely extends Debug's usage and leaves all else intact.
const logger = require("debug-symbols")("namespace");
// Extend logger, Internally does debug.extend()
logger.extend("extend-to");
// This runs debug() as you might expect
logger.log("Default usage");
// Adding various log levels...
logger.debug("debug");
logger.info("info");
logger.warn("warn");
logger.error("error");
logger.fatal("fatal");
logger.fail("failed");
logger.success("success");
This will log something like this:
Default Namespaces
When working with a large project, you might want to have a default main namespace.
For example.
For Example:
Assume my project is called
aws-server
I would want all scripts usingdebug-symbols
to have their namespace asaws-server:script-name
The default namespace in this case is aws-server
. Instead of repeating it in every script, I can set it globally using the environment variable DEBUG_NS
and each module will adopt it.
In this case:
- The namespace
express
becomesaws-server:express
. - The namespace
aws-server:admin-route
remainsaws-server:admin-route
.
So to show my logs, all I need is add process.env.DEBUG="aws-server*
and all my scripts will log as expected.