Merge pull request #7 from buggerjs/jk-help

Add `help` command

Author: hybrist

lib/internal/inspect-repl.js

@@ -40,6 +40,32 @@ const SHORTCUTS = {
   run: 'r',
 };
 
+const HELP = `
+run, restart, r       Run the application or reconnect
+kill                  Kill a running application or disconnect
+
+cont, c               Resume execution
+next, n               Continue to next line in current file
+step, s               Step into, potentially entering a function
+out, o                Step out, leaving the current function
+backtrace, bt         Print the current backtrace
+list                  Print the source around the line where execution is currently paused
+
+setBreakpoint, sb     Set a breakpoint
+clearBreakpoint, cb   Clear a breakpoint
+breakpoints           List all known breakpoints
+
+watch(expr)           Start watching the given expression
+unwatch(expr)         Stop watching an expression
+watchers              Print all watched expressions and their current values
+
+exec(expr)            Evaluate the expression and print the value
+repl                  Enter a debug repl that works like exec
+
+scripts               List application scripts that are currently loaded
+scripts(true)         List all scripts (including node-internals)
+`.trim();
+
 function getRelativePath(filename) {
   const dir = `${Path.resolve()}/`;
 
@@ -629,6 +655,10 @@ function createRepl(inspector) {
 
   function initializeContext(context) {
     copyOwnProperties(context, {
+      get help() {
+        print(HELP);
+      },
+
       get run() {
         return inspector.run();
       },

test/cli/help.test.js

@@ -0,0 +1,22 @@
+'use strict';
+const { test } = require('tap');
+
+const startCLI = require('./start-cli');
+
+test('examples/empty.js', (t) => {
+  const cli = startCLI(['examples/empty.js']);
+
+  function onFatal(error) {
+    cli.quit();
+    throw error;
+  }
+
+  return cli.waitFor(/break/)
+    .then(() => cli.waitForPrompt())
+    .then(() => cli.command('help'))
+    .then(() => {
+      t.match(cli.output, /run, restart, r\s+/m);
+    })
+    .then(() => cli.quit())
+    .then(null, onFatal);
+});