ManuelHentschel / vscDebugger

(Partial) Implementation of the Debug Adapter Protocol for R
https://manuelhentschel.github.io/vscDebugger/
MIT License
90 stars 14 forks source link

Documentation for Testing and Compiling the Debugger Protocol Adapter #197

Open nev-awaken opened 2 months ago

nev-awaken commented 2 months ago

Hi,

I recently made some updates to the debugger protocol adapter and would like to test my changes, but I’m not entirely sure how to properly compile and test the adapter. It would be really helpful if there were some documentation in the CONTRIBUTING.md file or elsewhere in the repo that outlines:

Thanks

ManuelHentschel commented 2 months ago

This will hopefully not be too difficult. You simply have to install the modified version of vscDebugger as you would any other R package (from source). This will overwrite the "official" package and automatically be used by the vscode extension. To go back, you can install the current master version the same way. Since the package contains compiled C code, you might need to be careful that the package is not loaded anywhere, which might cause the installation to fail.

I'll add a few lines to CONTRIBUTING.md about this.

Let me know if you have any specific questions!