status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

How to debug (#1835) 

* How to debug C++ code using VSCode.
This commit is contained in:
Kenneth Geisshirt 2018-05-29 18:06:15 +02:00 committed by GitHub
parent b0535cb2c2
commit 5c035fbdce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -83,6 +83,26 @@ npm install --build-from-source=realm
- Check [node-gyp](https://github.com/nodejs/node-gyp) manual for custom installation procedure for Windows
## Debugging the node addon
You can use (Visual Studio Code)[https://code.visualstudio.com/] to develop and debug. In the `.vscode` folder, configuration for building and debugging has been added for your convience.
VSCode has good support for debugging JavaScript, but to work with C++ code, you are required to install two additional VSCode extensions:
* Microsoft C/C++
* CodeLLDB
To begin, you will need to build the node addon and prepare the test environment:
```
npm install --build-from-source --debug
(cd tests && npm install)
```
Prior to begin debugging, you must start Realm Object Server. In VSCode, under menu *Tasks*/*Run Task*, find *Download and Start Server*.
In the debugging pane, you can find `Debug LLDB + NodeJS` in the dropdown. First select *Start Debugging* in the *Debug* menu.
## Issues with debugging
Some users have reported the Chrome debugging being too slow to use after integrating Realm into their react-native project. This is due to the blocking nature of the RPC calls made through the Realm library. It is an ongoing issue and we are actively working on fixing it. See https://github.com/realm/realm-js/issues/491 for more information.