Quick Start

Here are a few example videos showing how to set up and use PlutoVSCodeDebugger for debugging.

All of the videos below are recording of code execution from the example notebook found at examples/test_notebook.jl

Connecting to VSCode

Connecting to a running vscode instance is done via the @connect_vscode macro. The macro expects a single begin-end block containing the connection command copied from VSCode.

When executed with no argument, the macro will simply modify its cell to include the begin-end block for convenience.

Debug Package Code

To debug code defined inside a package loaded within Pluto the workflow is very straightforward. One sets breakpoints in the connected VSCode and those are hit when using the @run macro.

To simplify opening up the desired file location associated to a method or function, one can use the @vscedit macro directly from the notebook. This will open the file location associated to the provided function or method in the connected VSCode instance.

The synthax of @vscedit is very similar to @edit from InteractiveUtils, but check the docstrings for more information.

Debug Included Code

Debugging code that is directly included in the notebook with include also works equivalently to code defined inside a package.

Debug Notebook Code

Debugging code defined inside the notebook can not be done by adding breakpoint markers in the notebook file in VSCode.

This is because Pluto internally modifies the LineNumbers of expression associated to the notebook code so a breakpoint added on the notebook file on VSCode will not be triggered when executing code from Pluto.

While not as convenient as setting breakpoints using the VSCode UI, one can still manually set breakpoint either by inserting the @bp macro in function definitions or by using the @breakpoint macro with a call signature.