Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Orion/Documentation/Developer Guide/Debugger"
< Orion | Documentation | Developer Guide
(Add setup instructions) |
|||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
= Development Setup = | = Development Setup = | ||
| − | + | The code is in master!! | |
Instructions to follow! | Instructions to follow! | ||
| − | + | * Go to '''ORION_PATH/modules/orionode''' and run '''npm install''' | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | * Go to | + | |
* (optional) Configure debug adapters | * (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 | * Enable debug server | ||
| − | + | # Go to '''ORION_PATH/modules/orionode.debug.server''' | |
| − | + | # Run '''npm install''' | |
| − | + | ||
| − | + | ||
| − | + | ||
* Run Orion node server | * Run Orion node server | ||
| − | + | # Edit '''ORION_PATH/modules/orionode/orion.conf''' | |
| − | + | # Set '''orion.debug.enabled''' to true | |
| + | # Set '''debug.server.module''' to '''../orionode.debug.server''' (by default it's there already) | ||
| + | # Edit '''ORION_PATH/bundles/org.eclipse.orion.client.ui/web/defaults.pref''' | ||
| + | # Add '''"/general/settings":{"generalSettings": {"enableDebuggerVisible": true}}''' | ||
| + | # Go to '''ORION_PATH/modules/orionode''' | ||
| + | # Run '''npm install''' | ||
| + | # Run '''node server.js''' | ||
| + | * Enable debug frontend | ||
| + | # Open http://localhost:8081 (or other port you are listening to) | ||
| + | # Go to settings page by clicking the gear button on the left | ||
| + | # Go to general settings | ||
| + | # Enable debugger | ||
* Create a sample program | * 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 | * 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 | |
| + | |||
| + | [[Category:Orion]] | ||
Latest revision as of 09:02, 20 September 2017
Development Setup
The code is in master!!
Instructions to follow!
- 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
- Run Orion node server
- Edit ORION_PATH/modules/orionode/orion.conf
- Set orion.debug.enabled to true
- Set debug.server.module to ../orionode.debug.server (by default it's there already)
- Edit ORION_PATH/bundles/org.eclipse.orion.client.ui/web/defaults.pref
- Add "/general/settings":{"generalSettings": {"enableDebuggerVisible": true}}
- Go to ORION_PATH/modules/orionode
- Run npm install
- Run node server.js
- Enable debug frontend
- Open http://localhost:8081 (or other port you are listening to)
- Go to settings page by clicking the gear button on the left
- Go to general settings
- Enable debugger
- 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