forked from debug-js/debug
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 73fce84
Showing
10 changed files
with
202 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.DS_Store | ||
node_modules | ||
*.sock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
support | ||
test | ||
examples | ||
*.sock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
|
||
0.0.1 / 2010-01-03 | ||
================== | ||
|
||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
|
||
test: | ||
@echo "populate me" | ||
|
||
.PHONY: test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
|
||
# debug | ||
|
||
tiny node.js debugging utility. | ||
|
||
## Example | ||
|
||
This module is modelled after node core's debugging technique, allowing you to enable one or more topic-specific debugging functions, for example core does the following within many modules: | ||
|
||
```js | ||
var debug; | ||
if (process.env.NODE_DEBUG && /cluster/.test(process.env.NODE_DEBUG)) { | ||
debug = function(x) { | ||
var prefix = process.pid + ',' + | ||
(process.env.NODE_WORKER_ID ? 'Worker' : 'Master'); | ||
console.error(prefix, x); | ||
}; | ||
} else { | ||
debug = function() { }; | ||
} | ||
``` | ||
|
||
This concept is extremely simple but it works well. With `debug` you simply invoke the exported function to generate your debug function, passing it a name which will determine if a noop function is returned, or a decorated `console.error`, so all of the `console` format string goodies you're used to work fine. A unique color is selected per-function for visibility. | ||
|
||
Example _app.js_: | ||
|
||
```js | ||
var debug = require('debug')('http') | ||
, http = require('http') | ||
, name = 'My App'; | ||
|
||
// fake app | ||
|
||
debug('booting %s', name); | ||
|
||
http.createServer(function(req, res){ | ||
debug(req.method + ' ' + req.url); | ||
res.end('hello\n'); | ||
}).listen(3000, function(){ | ||
debug('listening'); | ||
}); | ||
|
||
// fake worker of some kind | ||
|
||
require('./worker'); | ||
``` | ||
|
||
Example _worker.js_: | ||
|
||
```js | ||
var debug = require('debug')('worker'); | ||
|
||
setInterval(function(){ | ||
debug('doing some work'); | ||
}, 1000); | ||
``` | ||
|
||
The __DEBUG__ environment variable is then used to enable these based on space or comma-delimited names. Here are some examples: | ||
|
||
## License | ||
|
||
(The MIT License) | ||
|
||
Copyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining | ||
a copy of this software and associated documentation files (the | ||
'Software'), to deal in the Software without restriction, including | ||
without limitation the rights to use, copy, modify, merge, publish, | ||
distribute, sublicense, and/or sell copies of the Software, and to | ||
permit persons to whom the Software is furnished to do so, subject to | ||
the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be | ||
included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, | ||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY | ||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, | ||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
|
||
var debug = require('../')('http') | ||
, http = require('http') | ||
, name = 'My App'; | ||
|
||
// fake app | ||
|
||
debug('booting %s', name); | ||
|
||
http.createServer(function(req, res){ | ||
debug(req.method + ' ' + req.url); | ||
res.end('hello\n'); | ||
}).listen(3000, function(){ | ||
debug('listening'); | ||
}); | ||
|
||
// fake worker of some kind | ||
|
||
require('./worker'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
|
||
var debug = require('../')('worker'); | ||
|
||
setInterval(function(){ | ||
debug('doing some work'); | ||
}, 1000); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
|
||
module.exports = require('./lib/debug'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
|
||
/*! | ||
* debug | ||
* Copyright(c) 2011 TJ Holowaychuk <tj@vision-media.ca> | ||
* MIT Licensed | ||
*/ | ||
|
||
/** | ||
* Expose `debug()` as the module. | ||
*/ | ||
|
||
module.exports = debug; | ||
|
||
/** | ||
* Library version. | ||
*/ | ||
|
||
exports.version = '0.0.1'; | ||
|
||
/** | ||
* Enabled debuggers. | ||
*/ | ||
|
||
var names = (process.env.DEBUG || '').split(/[\s,]+/); | ||
|
||
/** | ||
* Colors. | ||
*/ | ||
|
||
var colors = [6, 2, 3, 4, 5, 1]; | ||
|
||
/** | ||
* Previously assigned color. | ||
*/ | ||
|
||
var prevColor = 0; | ||
|
||
/** | ||
* Select a color. | ||
* | ||
* @return {Number} | ||
* @api private | ||
*/ | ||
|
||
function color() { | ||
return colors[prevColor++ % colors.length]; | ||
} | ||
|
||
/** | ||
* Create a debugger with the given `name`. | ||
* | ||
* @param {String} name | ||
* @return {Type} | ||
* @api public | ||
*/ | ||
|
||
function debug(name) { | ||
if (!~names.indexOf(name)) return function(){}; | ||
var c = color(); | ||
return function(fmt){ | ||
fmt = ' \033[3' + c + 'm' + name + '\033[90m ' + fmt + '\033[0m'; | ||
console.error.apply(this, arguments); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"name": "debug" | ||
, "version": "0.0.1" | ||
, "description": "small debugging utility" | ||
, "keywords": ["debug"] | ||
, "author": "TJ Holowaychuk <tj@vision-media.ca>" | ||
, "dependencies": {} | ||
, "devDependencies": { "mocha": "*" } | ||
, "main": "index" | ||
, "engines": { "node": "0.4.x" } | ||
} |