debug-engine

debug-engine

A simple GUI based debugger for node.js applications

Usage

At the very beginning of your script, create a new DebugEngine instance:

const DebugEngine = require('debug-engine')
const debugEngine = new DebugEngine()

And replace the console with the debugEngine console:

console = debugEngine.console

After starting your express app (if you are using express), call the onListen method:

app.listen(3000, () => {
    debugEngine.onListening()() // Yes, you need to use double ()
})

If you are using express, you also need to pipe the app into debugEngine before definig your routes and after every middleware:

debugEngine.pipe(app)

Now you can use the DebugEngine GUI. Happy debugging!

Environment

When creating a new DebugEngine instance, you can pass an environment object to the constructor, which determines if the debugger should be started automatically or not.

Automatically start debugger:

const debugEngine = new DebugEngine('development')

Don't start debugger:

const debugEngine = new DebugEngine('production')

Downlogger Integration

If you are using downlogger, and want to pipe the logs into the DebugEngine, you can simply use DownLogger.setCustomConsole(debugEngine.console):

// DebugEngine
const DebugEngine = require('debug-engine')
const debugEngine = new DebugEngine()

// Downlogger
const DownLogger = require('downlogger')
const Logger = new DownLogger()
Logger.setCustomConsole(debugEngine.console)