debuggler

Resolves debug namespace like magic.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
debuggler
1.0.04 years ago4 years agoMinified + gzip package size for debuggler in KB

Readme

debuggler
Build Status Code Climate Test Coverage
debuggler is a visionmedia/debug wrapper that is able to resolves it's caller path and package.json information, so it needs no configuration.

Install

$ npm install debuggler

Usage

/**
 * /home/example/package.json 
 *   name: example
 *   version: 1.0.0
 * /home/example/foo/bar.js
 */
process.env.DEBUG = 'example*';

const debug = require('debuggler')({ version: true });

debug('I know where I am!');
// Should output: example@1.0.0:foo:bar I know where I am!

API

| Argument | Type | Default Value | Description | |------------------------|-----------------|---------------|----------------------------------------------------------------------| | options | String\|Object | {} | Debug namespace string or an options object. | | options.namespace | String | undefined | Namespace is just passed to debug module, other options are ignored. | | options.name | String | true | Project name or true to get it from package.json. | | options.version | String\|Boolean | false | Version string or true to get it from package.json. | | options.verSeparator | String | '@' | Version separator character. | | options.dirSeparator | String | ':' | Directory separator character. | | options.file | String\|Boolean | true | File name or true to get the current one. | | options.ext | String\|Boolean | false | File extension or true to get the current one. |

License

Licence © Rodrigo Gomes da Silva