https://github.com/kvz/node-depurar
Node.js debugging for the truly lazy
https://github.com/kvz/node-depurar
Last synced: about 2 months ago
JSON representation
Node.js debugging for the truly lazy
- Host: GitHub
- URL: https://github.com/kvz/node-depurar
- Owner: kvz
- License: mit
- Created: 2015-06-19T11:55:09.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T06:55:14.000Z (over 1 year ago)
- Last Synced: 2025-04-13T08:47:17.715Z (about 2 months ago)
- Language: CoffeeScript
- Homepage: https://www.npmjs.com/package/depurar
- Size: 38.1 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# depurar
[](https://travis-ci.org/kvz/node-depurar)
[](https://coveralls.io/r/kvz/node-depurar?branch=master)
[](https://www.npmjs.com/package/depurar)
[](https://david-dm.org/kvz/node-depurar)
[](https://david-dm.org/kvz/node-depurar#info=devDependencies)
> **depurar** (first-person singular present indicative depuro, past participle depurado)
> 1. to purify, cleanse
> 2 (computing) To debug
Depurar is a wrapper around [`debug`](https://www.npmjs.com/package/debug) adding a couple
of features for the truly lazy.
## Install
```bash
npm install --save depurar
```
## Usage
Here are some examples of using Depurar. Most of which is very similar to the [`debug`](https://www.npmjs.com/package/debug) module that's powering it under the hood.
## Added features
### Automatically establish namespace
[`debug`](https://www.npmjs.com/package/debug) uses the convention of prefixing output with a namespace, in the form of: `Library:feature`.
This allows us to quickly enable/disable debug output for some libraries or features via environment variables such as `DEBUG=Library:*`. In my interpretation of this convention, this often leads to `ModuleName:ClassName`.
So I got a bit tired of opening `~/code/foo/lib/Bar.js` and typing:
```javascript
var dbg = require('debur')('foo:Bar');
dbg('ohai');
// prints " foo:Bar ohai",
```
So with Depurar, the second part will be based on the basename of the file where you require it:
```javascript
var dbg = require('depurar')('foo');
dbg('ohai');
// prints " foo:Bar ohai", in the case of `~/code/foo/lib/Bar.js`
```
What's more, if you are really truly lazy, the first part of this namespace can even be [guessed](https://www.npmjs.com/package/app-root-path) based on the root directory name of your library/app:
```javascript
var dbg = require('depurar')();
dbg('ohai');
// prints " foo:Bar ohai", in the case of `~/code/foo/lib/Bar.js`
```
### Pick color based on namespace, not rotation
[`debug`](https://www.npmjs.com/package/debug) by default picks the next color from a list, every time it gets instantiated, meaning you'll get a new color for every entity that's talking to you. However this also often means that with every run or change, every entity has a new color again. First world's problems - but the brain is great at recognizing patterns via color and so if every entity had it's own color, debug information would be easier to digest.
That's the reasoning. And that's why Depurar uses an algorithm to reduce the namespace to a single color. This makes every class or feature speak in the same color, always - at the tradeoff of an increased likelihood of a color being used twice.
## FAQ
### Is Depurar more efficient than debug?
While I'm too lazy to benchmark, considering there's extra pathfinding and computation involved, I'd say: No. That said, if the bottleneck in your app becomes Depurar, I'll either be very impressed or underwhelmed by your library/app. At any rate I'd be interested to learn about it: reach out.
## Todo
- [ ] Support for enabling adding the linenumber to the debug prefix
- [ ] Support for disabling colorpicking by namespace
- [ ] More colors, make duration the same color, freeing some variances up
- [ ] Better algorithm for establishing color via namespace, meaning small changes make big differences already
## Sponsor Development
Like this project? Consider a donation.
[](https://www.gittip.com/kvz/ "Sponsor the development of depurar via Gittip")
[](https://flattr.com/submit/auto?user_id=kvz&url=https://github.com/kvz/depurar&title=depurar&language=&tags=github&category=software "Sponsor the development of depurar via Flattr")
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=kevin%40vanzonneveld%2enet&lc=NL&item_name=Open%20source%20donation%20to%20Kevin%20van%20Zonneveld¤cy_code=USD&bn=PP-DonationsBF%3abtn_donate_SM%2egif%3aNonHosted "Sponsor the development of depurar via Paypal")
[](https://coinbase.com/checkouts/19BtCjLCboRgTAXiaEvnvkdoRyjd843Dg2 "Sponsor the development of depurar via BitCoin")