ndx

extended node debugger server and client cli on v8 debugger protocol

features

• able to register watchers to automate the debugging process
• Watcher#onDebugEvent interface returns inspector object based on v8 debugger protocol
• watcher enables to blackbox and stepover the custom or internal scripts when stepping and trace function calls and variables
• separated server executable and client cli makes debugging dockerized node app possible

pending works

• update the cli interface for more easier readability
• add typings
• update demo gif
• support Nestjs

demo

install

yarn global add @ecpy/ndx

# help
npx @ecpy/ndx --help

# launch debug server
npx @ecpy/ndx -s -h localhost -p 3000 $APP 

# launch as debug cli client with watchers
npx @ecpy/ndx -c -h localhost -p 3000 -w $WATCHERS_FILE

examples

• watcher samples are located at ${PACKAGE_ROOT}/watcher-samples

cd $PACKAGE_ROOT

# test server
./cli.js -s -h localhost -p 3000 ./app-sample 

# test client
./cli.js -c -h localhost -p 3000 -w ./watcher-samples/index.js

ndx> pause

ndx> next

# debug APIs
ndx> help

• watcher class structure

class VariablesWatcher extends Watcher {
    onDebugEvent(inspector, domain, name, params, nextWatcher) {
        if (domain == 'Runtime') {
            this.log('I am watching runtime domain calls');
        }
        nextWatcher();
    }
}

debug APIs

• protocol method calls are defined on the inspector object returned by Watcher#onDebugEvent interface, see v8 debugger protocol

development

• parts of the debugger structure is referenced from node-inspect