tmp-debug v0.12.5

tmp-debug

Debug node applications with tmp files.

Motivation

While trying to understand how a daemon application worked, I wasn't able to debug with node-inspector very easily. The daemon also detached io streams, making console log/error a non starter. I ended up writing to a tmp file and decided to publish a module around it.

Here's some sample output that was written to a file:

Installing

It's recommended to install tmp-debug globally:

npm install -g tmp-debug

Usage

Programatically

var tmpDebug = require('tmp-debug')('log.txt');

tmpDebug.logStackTrace();
tmpDebug.log('foo');
function someFn() {
  tmpDebug.logArgs(arguments);
}
someFn();

Instrumenting

tmp-debug ./some/directory

All javascript files found in the directory will be instrumented with tmpDebug.logArgs(arguments); in every function found therein.

Viewing

Once you're logging, you can view the file output in the following ways:

• tail -f /tmp/log.txt
• less -R /tmp/log.txt

Configuring

Place .tmpdebugrc on your path.

Example Config File

{
  "enabled": true,
  "filters": [
    {
      "file": "optional/path/some-file.js",
      "functionName": "someFunctionName",
      "line": 50,
      "column": 30
    }
  ],
  "outputDepth": 3
}

filters

An array of filter objects that control what gets logged.

• file filters files that end with it's value.
• functionName filters functions that end with it's value.
• line filters functions that occor on this line.
• column filters functions that occur on this column.

outputDepth

An integer controlling how many levels deep inspected objects will be logged.

##LICENSE

The MIT License (MIT)

Copyright (c) 2015 jsdevel

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.