ebug
A mini NodeJS debug module based on https://github.com/visionmedia/debug.
Optional Features
- Terminal coloring for namespace & timestamps.
- Real time timestamp of call to
ebug
or millisecond difference of timestamps between calls toebug
for the given namespace. - Optional global namespace prefix for messages.
- Custom string for spacing around namespaces in messages.
- Uses util.format internally, so all of the formatting there is available.
Usage
- Initialize with the debugging namespace of the module (which will be colorized in terminal output).
- Run with the DEBUG environment variable properly set for the given module, or multiple modules, to see output.
test.js
// Using default optionsconst debug = 'test' // With custom optionsconst debug = 'test' namespacePrefix: '@' realTime: true useISO: true useColors: false spacingString: '\t'
terminal/command line
Output With Default Options (coloring added by markdown formatting for example effect)
DEBUG=test node testjs test Something something something...dark side +0ms
Output From Custom Options Above (coloring removed for example effect)
DEBUG=test node test.js2018-08-17T10:17:50.411Z @test Something something something...dark side.
Using A Wildcard For process.env.DEBUG
(coloring added by markdown formatting for example effect)
DEBUG=test**test*test* node testjs test Something something something...dark side +0ms
In the above example each of test*, *test, and *test* matches the namespace test.
Options
Name | Default | Explanation |
---|---|---|
namespacePrefix |
'' | Prepended to namespaces in messages. |
realTime |
false | Use real timestamps instead of millisecond difference. |
useISO |
false | Use ISO timestamps instead of UTC. |
useColors |
true | Use colors for terminal output. |
spacingString |
' ' | Custom spacing around namespace in messages. |
Note
Black (30) has been removed from the list of colors available for now. Will return with background coloring included in a future update, unless I can find some way to get the background color of the terminal..