lazy-debug

lazy-debug is a helper for visionmedia´s debug. It generates module identifiers based on __filename, so your debug identifiers reflect the file structure automatically.

Supports

Node.js v0.10 and later
Windows and Linux
Browserify
Webpack

Install

npm install --save debug lazy-debug

The module works out of the box in Node.js and Browserify environments.

Webpack

Webpack needs configuration, include these in your webpack.config.js:

config.node = {
  __filename: true, // populates filenames relative to your app root
  fs: "empty"       // include empty "mock" for fs module
}

Usage

Just require it and provide filename:

var debug = require('lazy-debug')(__filename)
debug('ready for logging..')

Debugger identifier will be relative to module root, ie. something like dir:file. File extensions are omitted and file name is omitted if it´s index.

Suffix

Add suffix by providing submoduleName:

var debug = require('lazy-debug')(__filename, {submoduleName: 'sub'})
var debug = require('lazy-debug')(__filename, 'sub')

Debugger identifier will be dir:file:sub.

Prefix

Add prefix by providing packageName:

var debug = require('lazy-debug')(__filename, {packageName: 'my-lib'})
var debug = require('lazy-debug')(__filename, {packageName: true})

Debugger identifier will be my-lib:dir:file. If package name is boolean true, name from package.json is used. That works only in Node.js environment.

Tests

npm test

Tests node.js compability by running vanilla Mocha at first, then Browserify and Webpack builds are tested in PhantomJS using Karma.