Revision as of 16:37, 20 April 2017

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

1. You need Node.js v4.4.6+ to run Orion node server
2. Checkout Orion client code (See https://wiki.eclipse.org/Orion/Getting_the_source)
3. Go to https://git.eclipse.org/r/#/c/93161/
4. 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

1. By default, node, python, java and lldb adapters are configured
2. If you don't need more or less adapters, you can skip this part
3. Open ORION_PATH/modules/orionode.debug.server/adapters.json
4. 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

1. Go to ORION_PATH/modules/orionode.debug.server
2. Run npm install
3. Edit ORION_PATH/modules/orionode/orion.conf
4. Enable debug.server.module

• Run Orion node server

1. Go to ORION_PATH/modules/orionode
2. Run node server.js

• Enable debug frontend

1. Open http://localhost:8081 (or other port you are listening to)
2. Go to settings page by clicking the gear button on the left
3. Go to general settings
4. Enable debugger

• Create a sample program

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

• More tips

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