Orion/Documentation/Developer Guide/Debugger

Development Setup

Since this code is so new at the moment, you need to do a cherry pick from the gerrit patch on top of the existing Orion node server code.

Instructions to follow!

• Get code

   * You need Node.js v4.4.6+ to run Orion node server
   * Checkout Orion client code (See https://wiki.eclipse.org/Orion/Getting_the_source)
   * Go to https://git.eclipse.org/r/#/c/93161/
   * Find "Download" at the top right corner and apply this patch to your Orion code

• Go to ```ORION_PATH/modules/orionode``` and run ```npm install```
• (optional) Configure debug adapters

   * By default, node, python, java and lldb adapters are configured
   * If you don't need more or less adapters, you can skip this part
   * Open ```ORION_PATH/modules/orionode.debug.server/adapters.json```
   * Add new adapters in this json file. You can find available adapters and their git repositories in VSCode marketplace by searching "debugger"

• Enable debug server

   * Go to ```ORION_PATH/modules/orionode.debug.server```
   * Run ```npm install```

• Enable debug UI

   * Go to ```ORION_PATH/bundles/org.eclipse.orion.client.ui/web/defaults.pref```
   * Add ```"debug/plugins/debugPlugin.html": true```

• Run Orion node server

   * Go to ```ORION_PATH/modules/orionode```
   * Run ```node server.js```

• Create a sample program

   * Open http://localhost:8081 (or other port you are listening to)
   * Create a new folder at the root of your workspace
   * Create a new file called ```server.js``` in this new folder
   * Type in ```console.log('Hello World!');```
   * Click the run bar at the top, and click "+Native"
   * Change "Debug Adapter Type" to "node"
   * Click "Select a Template" and select "Default"
   * Press "Save"
   * Click the play button in the run bar
   * Now you can see the debug UI and the output from the hello world program

• More tips

   * Double click a line number to add or remove a breakpoint
   * Hold alt and double click a line number to add or remove a conditional breakpoint, although some debug adapters don't support conditional breakpoints
   * Third-party adapters might not work as good as adapters like node