Plugin for debugging your base application.
Install with npm:
$ npm i base-debug --save
To test-drive the plugin, add this to example.js (or just use the examples/example.js file in this project):
var debug = require('base-debug');
var Base = require('base');
var base = new Base();
base.use(debug('foo'));
var one = base.debug('one');
var two = base.debug('two');
one('this is one!');
two('this is two!');
Then, in the command line:
DEBUG=base:* node exampleDEBUG=base:one node example(See the debug docs for more information about using debug on all platforms.)
Namespace
Inside your plugin, register the debug() plugin, passing the name of your plugin as the "namespace" to use:
// given you have a plugin named `base-foo`
function baseFoo(options) {
return function(app) {
app.use(debug('foo'));
// then call the `app.debug` method
var debug = app.debug();
// then use it like this:
debug('yelling abc: %s', 'ABC!');
debug('yelling xyz: %s', 'XYZ!');
}
}
When your plugin is registered, like this:
// Add your plugin
var base = new Base();
base.use(baseFoo());
and the DEBUG=base:foo command is used, you should see something like this in the terminal:
(See the debug docs for more information about using debug on all platforms.)
Sub-namespaces
Optionally use "sub-namespaces":
function baseFoo(options) {
return function(app) {
app.use(debug('foo'));
// namespace `foo:one`
var one = app.debug('one');
// namespace `foo:two`
var two = app.debug('two');
// then use it like this:
one('yelling abc: %s', 'ABC!');
two('yelling xyz: %s', 'XYZ!');
}
}
When your plugin is registered, like this:
// Add your plugin
var base = new Base();
base.use(baseFoo());
and the following commands are used:
DEBUG=base:foo:*, orDEBUG=base:foo:one, orDEBUG=base:foo:twoYou should see something like this in the terminal:
(See the debug docs for more information about using debug on all platforms.)
You might also be interested in these projects:
option, enable and disable. See the readme… more | homepageInstall dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
Copyright © 2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb on January 23, 2016.