debug
Advanced tools
Comparing version 2.6.8 to 3.0.0
| 3.0.0 / 2017-08-08 | ||
| ================== | ||
| * Breaking: Remove DEBUG_FD (#406) | ||
| * Breaking: Use `Date#toISOString()` instead to `Date#toUTCString()` when output is not a TTY (#418) | ||
| * Breaking: Make millisecond timer namespace specific and allow 'always enabled' output (#408) | ||
| * Addition: document `enabled` flag (#465) | ||
| * Addition: add 256 colors mode (#481) | ||
| * Addition: `enabled()` updates existing debug instances, add `destroy()` function (#440) | ||
| * Update: component: update "ms" to v2.0.0 | ||
| * Update: separate the Node and Browser tests in Travis-CI | ||
| * Update: refactor Readme, fixed documentation, added "Namespace Colors" section, redid screenshots | ||
| * Update: separate Node.js and web browser examples for organization | ||
| * Update: update "browserify" to v14.4.0 | ||
| * Fix: fix Readme typo (#473) | ||
| 2.6.8 / 2017-05-18 | ||
@@ -3,0 +19,0 @@ ================== |
@@ -5,3 +5,3 @@ { | ||
| "description": "small debugging utility", | ||
| "version": "2.6.8", | ||
| "version": "3.0.0", | ||
| "keywords": [ | ||
@@ -18,4 +18,4 @@ "debug", | ||
| "dependencies": { | ||
| "rauchg/ms.js": "0.7.1" | ||
| "rauchg/ms.js": "2.0.0" | ||
| } | ||
| } |
| { | ||
| "name": "debug", | ||
| "version": "2.6.8", | ||
| "version": "3.0.0", | ||
| "repository": { | ||
@@ -24,3 +24,3 @@ "type": "git", | ||
| "devDependencies": { | ||
| "browserify": "9.0.3", | ||
| "browserify": "14.4.0", | ||
| "chai": "^3.5.0", | ||
@@ -27,0 +27,0 @@ "concurrently": "^3.1.0", |
171
README.md
@@ -5,6 +5,7 @@ # debug | ||
| <img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> | ||
| A tiny JavaScript debugging utility modelled after Node.js core's debugging | ||
| technique. Works in Node.js and web browsers. | ||
| A tiny node.js debugging utility modelled after node core's debugging technique. | ||
| **Discussion around the V3 API is under way [here](https://github.com/visionmedia/debug/issues/370)** | ||
@@ -22,3 +23,3 @@ | ||
| Example _app.js_: | ||
| Example [_app.js_](./examples/node/app.js): | ||
@@ -32,3 +33,3 @@ ```js | ||
| debug('booting %s', name); | ||
| debug('booting %o', name); | ||
@@ -47,58 +48,104 @@ http.createServer(function(req, res){ | ||
| Example _worker.js_: | ||
| Example [_worker.js_](./examples/node/worker.js): | ||
| ```js | ||
| var debug = require('debug')('worker'); | ||
| var a = require('debug')('worker:a') | ||
| , b = require('debug')('worker:b'); | ||
| setInterval(function(){ | ||
| debug('doing some work'); | ||
| }, 1000); | ||
| function work() { | ||
| a('doing lots of uninteresting work'); | ||
| setTimeout(work, Math.random() * 1000); | ||
| } | ||
| work(); | ||
| function workb() { | ||
| b('doing some work'); | ||
| setTimeout(workb, Math.random() * 2000); | ||
| } | ||
| workb(); | ||
| ``` | ||
| The __DEBUG__ environment variable is then used to enable these based on space or comma-delimited names. Here are some examples: | ||
| The `DEBUG` environment variable is then used to enable these based on space or | ||
| comma-delimited names. | ||
|  | ||
| Here are some examples: | ||
|  | ||
| <img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png"> | ||
| <img width="647" alt="screen shot 2017-08-08 at 12 53 38 pm" src="https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png"> | ||
| <img width="647" alt="screen shot 2017-08-08 at 12 53 25 pm" src="https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png"> | ||
| #### Windows note | ||
| On Windows the environment variable is set using the `set` command. | ||
| On Windows the environment variable is set using the `set` command. | ||
| ```cmd | ||
| set DEBUG=*,-not_this | ||
| ``` | ||
| ```cmd | ||
| set DEBUG=*,-not_this | ||
| ``` | ||
| Note that PowerShell uses different syntax to set environment variables. | ||
| Note that PowerShell uses different syntax to set environment variables. | ||
| ```cmd | ||
| $env:DEBUG = "*,-not_this" | ||
| ``` | ||
| ```cmd | ||
| $env:DEBUG = "*,-not_this" | ||
| ``` | ||
| Then, run the program to be debugged as usual. | ||
| ## Namespace Colors | ||
| Every debug instance has a color generated for it based on its namespace name. | ||
| This helps when visually parsing the debug output to identify which debug instance | ||
| a debug line belongs to. | ||
| #### Node.js | ||
| In Node.js, colors are enabled when stderr is a TTY. You also _should_ install | ||
| the [`supports-color`](https://npmjs.org/supports-color) module alongside debug, | ||
| otherwise debug will only use a small handful of basic colors. | ||
| <img width="521" src="https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png"> | ||
| #### Web Browser | ||
| Colors are also enabled on "Web Inspectors" that understand the `%c` formatting | ||
| option. These are WebKit web inspectors, Firefox ([since version | ||
| 31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/)) | ||
| and the Firebug plugin for Firefox (any version). | ||
| <img width="524" src="https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png"> | ||
| ## Millisecond diff | ||
| When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls. | ||
| When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls. | ||
|  | ||
| <img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> | ||
| When stdout is not a TTY, `Date#toUTCString()` is used, making it more useful for logging the debug information as shown below: | ||
| When stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below: | ||
|  | ||
| <img width="647" src="https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png"> | ||
| ## Conventions | ||
| If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". | ||
| If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". If you append a "*" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output. | ||
| ## Wildcards | ||
| The `*` character may be used as a wildcard. Suppose for example your library has debuggers named "connect:bodyParser", "connect:compress", "connect:session", instead of listing all three with `DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do `DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`. | ||
| The `*` character may be used as a wildcard. Suppose for example your library has | ||
| debuggers named "connect:bodyParser", "connect:compress", "connect:session", | ||
| instead of listing all three with | ||
| `DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do | ||
| `DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`. | ||
| You can also exclude specific debuggers by prefixing them with a "-" character. For example, `DEBUG=*,-connect:*` would include all debuggers except those starting with "connect:". | ||
| You can also exclude specific debuggers by prefixing them with a "-" character. | ||
| For example, `DEBUG=*,-connect:*` would include all debuggers except those | ||
| starting with "connect:". | ||
| ## Environment Variables | ||
| When running through Node.js, you can set a few environment variables that will | ||
| change the behavior of the debug logging: | ||
| When running through Node.js, you can set a few environment variables that will | ||
| change the behavior of the debug logging: | ||
@@ -113,13 +160,13 @@ | Name | Purpose | | ||
| __Note:__ The environment variables beginning with `DEBUG_` end up being | ||
| converted into an Options object that gets used with `%o`/`%O` formatters. | ||
| See the Node.js documentation for | ||
| [`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options) | ||
| for the complete list. | ||
| __Note:__ The environment variables beginning with `DEBUG_` end up being | ||
| converted into an Options object that gets used with `%o`/`%O` formatters. | ||
| See the Node.js documentation for | ||
| [`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options) | ||
| for the complete list. | ||
| ## Formatters | ||
| Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting. | ||
| Below are the officially supported formatters: | ||
| Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting. Below are the officially supported formatters: | ||
| | Formatter | Representation | | ||
@@ -134,5 +181,8 @@ |-----------|----------------| | ||
| ### Custom formatters | ||
| You can add custom formatters by extending the `debug.formatters` object. For example, if you wanted to add support for rendering a Buffer as hex with `%h`, you could do something like: | ||
| You can add custom formatters by extending the `debug.formatters` object. | ||
| For example, if you wanted to add support for rendering a Buffer as hex with | ||
| `%h`, you could do something like: | ||
@@ -151,11 +201,13 @@ ```js | ||
| ## Browser support | ||
| You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify), | ||
| or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest), | ||
| if you don't want to build it yourself. | ||
| Debug's enable state is currently persisted by `localStorage`. | ||
| Consider the situation shown below where you have `worker:a` and `worker:b`, | ||
| and wish to debug both. You can enable this using `localStorage.debug`: | ||
| ## Browser Support | ||
| You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify), | ||
| or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest), | ||
| if you don't want to build it yourself. | ||
| Debug's enable state is currently persisted by `localStorage`. | ||
| Consider the situation shown below where you have `worker:a` and `worker:b`, | ||
| and wish to debug both. You can enable this using `localStorage.debug`: | ||
| ```js | ||
@@ -180,14 +232,3 @@ localStorage.debug = 'worker:*' | ||
| #### Web Inspector Colors | ||
| Colors are also enabled on "Web Inspectors" that understand the `%c` formatting | ||
| option. These are WebKit web inspectors, Firefox ([since version | ||
| 31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/)) | ||
| and the Firebug plugin for Firefox (any version). | ||
| Colored output looks something like: | ||
|  | ||
| ## Output streams | ||
@@ -197,3 +238,3 @@ | ||
| Example _stdout.js_: | ||
| Example [_stdout.js_](./examples/node/stdout.js): | ||
@@ -220,3 +261,19 @@ ```js | ||
| ## Checking whether a debug target is enabled | ||
| After you've created a debug instance, you can determine whether or not it is | ||
| enabled by checking the `enabled` property: | ||
| ```javascript | ||
| const debug = require('debug')('http'); | ||
| if (debug.enabled) { | ||
| // do stuff... | ||
| } | ||
| ``` | ||
| You can also manually toggle this property to force the debug instance to be | ||
| enabled or disabled. | ||
| ## Authors | ||
@@ -303,3 +360,3 @@ | ||
| Copyright (c) 2014-2016 TJ Holowaychuk <tj@vision-media.ca> | ||
| Copyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca> | ||
@@ -306,0 +363,0 @@ Permission is hereby granted, free of charge, to any person obtaining |
@@ -23,8 +23,13 @@ /** | ||
| exports.colors = [ | ||
| 'lightseagreen', | ||
| 'forestgreen', | ||
| 'goldenrod', | ||
| 'dodgerblue', | ||
| 'darkorchid', | ||
| 'crimson' | ||
| '#0000CC', '#0000FF', '#0033CC', '#0033FF', '#0066CC', '#0066FF', '#0099CC', | ||
| '#0099FF', '#00CC00', '#00CC33', '#00CC66', '#00CC99', '#00CCCC', '#00CCFF', | ||
| '#3300CC', '#3300FF', '#3333CC', '#3333FF', '#3366CC', '#3366FF', '#3399CC', | ||
| '#3399FF', '#33CC00', '#33CC33', '#33CC66', '#33CC99', '#33CCCC', '#33CCFF', | ||
| '#6600CC', '#6600FF', '#6633CC', '#6633FF', '#66CC00', '#66CC33', '#9900CC', | ||
| '#9900FF', '#9933CC', '#9933FF', '#99CC00', '#99CC33', '#CC0000', '#CC0033', | ||
| '#CC0066', '#CC0099', '#CC00CC', '#CC00FF', '#CC3300', '#CC3333', '#CC3366', | ||
| '#CC3399', '#CC33CC', '#CC33FF', '#CC6600', '#CC6633', '#CC9900', '#CC9933', | ||
| '#CCCC00', '#CCCC33', '#FF0000', '#FF0033', '#FF0066', '#FF0099', '#FF00CC', | ||
| '#FF00FF', '#FF3300', '#FF3333', '#FF3366', '#FF3399', '#FF33CC', '#FF33FF', | ||
| '#FF6600', '#FF6633', '#FF9900', '#FF9933', '#FFCC00', '#FFCC33' | ||
| ]; | ||
@@ -31,0 +36,0 @@ |
@@ -17,2 +17,7 @@ | ||
| /** | ||
| * Active `debug` instances. | ||
| */ | ||
| exports.instances = []; | ||
| /** | ||
| * The currently active debug mode names, and names to skip. | ||
@@ -33,8 +38,2 @@ */ | ||
| /** | ||
| * Previous log timestamp. | ||
| */ | ||
| var prevTime; | ||
| /** | ||
| * Select a color. | ||
@@ -67,2 +66,4 @@ * @param {String} namespace | ||
| var prevTime; | ||
| function debug() { | ||
@@ -124,2 +125,3 @@ // disabled? | ||
| debug.color = selectColor(namespace); | ||
| debug.destroy = destroy; | ||
@@ -131,5 +133,17 @@ // env-specific initialization logic for debug instances | ||
| exports.instances.push(debug); | ||
| return debug; | ||
| } | ||
| function destroy () { | ||
| var index = exports.instances.indexOf(this); | ||
| if (index !== -1) { | ||
| exports.instances.splice(index, 1); | ||
| return true; | ||
| } else { | ||
| return false; | ||
| } | ||
| } | ||
| /** | ||
@@ -149,6 +163,7 @@ * Enables a debug mode by namespaces. This can include modes | ||
| var i; | ||
| var split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/); | ||
| var len = split.length; | ||
| for (var i = 0; i < len; i++) { | ||
| for (i = 0; i < len; i++) { | ||
| if (!split[i]) continue; // ignore empty strings | ||
@@ -162,2 +177,7 @@ namespaces = split[i].replace(/\*/g, '.*?'); | ||
| } | ||
| for (i = 0; i < exports.instances.length; i++) { | ||
| var instance = exports.instances[i]; | ||
| instance.enabled = exports.enabled(instance.namespace); | ||
| } | ||
| } | ||
@@ -184,2 +204,5 @@ | ||
| function enabled(name) { | ||
| if (name[name.length - 1] === '*') { | ||
| return true; | ||
| } | ||
| var i, len; | ||
@@ -186,0 +209,0 @@ for (i = 0, len = exports.skips.length; i < len; i++) { |
115
src/node.js
@@ -26,4 +26,19 @@ /** | ||
| exports.colors = [6, 2, 3, 4, 5, 1]; | ||
| exports.colors = [ 6, 2, 3, 4, 5, 1 ]; | ||
| try { | ||
| var supportsColor = require('supports-color'); | ||
| if (supportsColor && supportsColor.level >= 2) { | ||
| exports.colors = [ | ||
| 20, 21, 26, 27, 32, 33, 38, 39, 40, 41, 42, 43, 44, 45, 56, 57, 62, 63, 68, | ||
| 69, 74, 75, 76, 77, 78, 79, 80, 81, 92, 93, 98, 99, 112, 113, 128, 129, 134, | ||
| 135, 148, 149, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, | ||
| 172, 173, 178, 179, 184, 185, 196, 197, 198, 199, 200, 201, 202, 203, 204, | ||
| 205, 206, 207, 208, 209, 214, 215, 220, 221 | ||
| ]; | ||
| } | ||
| } catch (err) { | ||
| // swallow - we only care if `supports-color` is available; it doesn't have to be. | ||
| } | ||
| /** | ||
@@ -56,19 +71,2 @@ * Build up the default `inspectOpts` object from the environment variables. | ||
| /** | ||
| * The file descriptor to write the `debug()` calls to. | ||
| * Set the `DEBUG_FD` env variable to override with another value. i.e.: | ||
| * | ||
| * $ DEBUG_FD=3 node script.js 3>debug.log | ||
| */ | ||
| var fd = parseInt(process.env.DEBUG_FD, 10) || 2; | ||
| if (1 !== fd && 2 !== fd) { | ||
| util.deprecate(function(){}, 'except for stderr(2) and stdout(1), any other usage of DEBUG_FD is deprecated. Override debug.log if you want to use a different log function (https://git.io/debug_fd)')() | ||
| } | ||
| var stream = 1 === fd ? process.stdout : | ||
| 2 === fd ? process.stderr : | ||
| createWritableStdioStream(fd); | ||
| /** | ||
| * Is stdout a TTY? Colored output is enabled when `true`. | ||
@@ -80,3 +78,3 @@ */ | ||
| ? Boolean(exports.inspectOpts.colors) | ||
| : tty.isatty(fd); | ||
| : tty.isatty(process.stderr.fd); | ||
| } | ||
@@ -115,8 +113,9 @@ | ||
| var c = this.color; | ||
| var prefix = ' \u001b[3' + c + ';1m' + name + ' ' + '\u001b[0m'; | ||
| var colorCode = '\u001b[3' + (c < 8 ? c : '8;5;' + c); | ||
| var prefix = ' ' + colorCode + ';1m' + name + ' ' + '\u001b[0m'; | ||
| args[0] = prefix + args[0].split('\n').join('\n' + prefix); | ||
| args.push('\u001b[3' + c + 'm+' + exports.humanize(this.diff) + '\u001b[0m'); | ||
| args.push(colorCode + 'm+' + exports.humanize(this.diff) + '\u001b[0m'); | ||
| } else { | ||
| args[0] = new Date().toUTCString() | ||
| args[0] = new Date().toISOString() | ||
| + ' ' + name + ' ' + args[0]; | ||
@@ -127,7 +126,7 @@ } | ||
| /** | ||
| * Invokes `util.format()` with the specified arguments and writes to `stream`. | ||
| * Invokes `util.format()` with the specified arguments and writes to stderr. | ||
| */ | ||
| function log() { | ||
| return stream.write(util.format.apply(util, arguments) + '\n'); | ||
| return process.stderr.write(util.format.apply(util, arguments) + '\n'); | ||
| } | ||
@@ -164,70 +163,2 @@ | ||
| /** | ||
| * Copied from `node/src/node.js`. | ||
| * | ||
| * XXX: It's lame that node doesn't expose this API out-of-the-box. It also | ||
| * relies on the undocumented `tty_wrap.guessHandleType()` which is also lame. | ||
| */ | ||
| function createWritableStdioStream (fd) { | ||
| var stream; | ||
| var tty_wrap = process.binding('tty_wrap'); | ||
| // Note stream._type is used for test-module-load-list.js | ||
| switch (tty_wrap.guessHandleType(fd)) { | ||
| case 'TTY': | ||
| stream = new tty.WriteStream(fd); | ||
| stream._type = 'tty'; | ||
| // Hack to have stream not keep the event loop alive. | ||
| // See https://github.com/joyent/node/issues/1726 | ||
| if (stream._handle && stream._handle.unref) { | ||
| stream._handle.unref(); | ||
| } | ||
| break; | ||
| case 'FILE': | ||
| var fs = require('fs'); | ||
| stream = new fs.SyncWriteStream(fd, { autoClose: false }); | ||
| stream._type = 'fs'; | ||
| break; | ||
| case 'PIPE': | ||
| case 'TCP': | ||
| var net = require('net'); | ||
| stream = new net.Socket({ | ||
| fd: fd, | ||
| readable: false, | ||
| writable: true | ||
| }); | ||
| // FIXME Should probably have an option in net.Socket to create a | ||
| // stream from an existing fd which is writable only. But for now | ||
| // we'll just add this hack and set the `readable` member to false. | ||
| // Test: ./node test/fixtures/echo.js < /etc/passwd | ||
| stream.readable = false; | ||
| stream.read = null; | ||
| stream._type = 'pipe'; | ||
| // FIXME Hack to have stream not keep the event loop alive. | ||
| // See https://github.com/joyent/node/issues/1726 | ||
| if (stream._handle && stream._handle.unref) { | ||
| stream._handle.unref(); | ||
| } | ||
| break; | ||
| default: | ||
| // Probably an error on in uv_guess_handle() | ||
| throw new Error('Implement me. Unknown stream file type!'); | ||
| } | ||
| // For supporting legacy API we put the FD here. | ||
| stream.fd = fd; | ||
| stream._isStdio = true; | ||
| return stream; | ||
| } | ||
| /** | ||
| * Init logic for `debug` instances. | ||
@@ -234,0 +165,0 @@ * |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Fixed alerts
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by4.87%
53209
- Number of lines in readme file
- increased by18.21%
370
- Number of low supply chain risk alerts
- decreased by-25%
6
- Number of medium supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Lines of code
- decreased by-4.71%
567
No dependency changes