/PlutoVSCodeDebugger.jl

Small Experimental Package to connect a Pluto notebook to an open VSCode instance for debugging

Primary LanguageJuliaMIT LicenseMIT

PlutoVSCodeDebugger

Stable Dev Build Status Coverage

This package provides a very experimental connection between a Pluto Notebook and the Debugger on a running VSCode instance (the VSCode instance must be running on the same machine as the Pluto Server)

To connect VSCode to Pluto and exploit the @run and @enter commands, follow the steps below:

  • Copy the julia code to connect an external REPL from your VSCode window by calling the VSCode command Julia: Connect external REPL.
  • Bring this package into the notebook scope by having a cell with using PlutoVSCodeDebugger
  • Connect VSCode by calling the @connect_vscode macro by giving as an argument a begin...end block that contains the code pasted at point 1.

After executing the cell with @connect_vscode you should see a popup on VSCode like the one below confirming the successfull connection:

image

After succesfull connection you can directly start using the @enter and @run macros inside your Pluto notebook.

You can also use the exported @vscedit to jump at function definitions in VSCode from the Pluto notebook for convenience of setting up breakpoints. This function works similarly to the @edit macro from InteractiveUtils.

Check the documentation for more details on how to use this package.