Exported Functions

@connect_vscode begin 
    #=Pasted Code from VSCode=#
end

This macro is used within a Pluto notebook to connect a VSCode instance running on the same machine as the Pluto Server.

The way to connect the notebook is by following these steps:

• On VSCode, execute the Julia: Connect external REPL command and copy the returned code snippet
• Make sure that PlutoVSCodeDebugger is loaded in the target Pluto notebook by having the using PlutoVSCodeDebugger statement inside a cell
• Create a new cell (or modify an existing cell) putting the code copied at point 1 inside a begin - end block passed to the @connect_vscode macro, like shown in the call signature at the top of this docstring.
• Execute the cell containing @connect_vscode.

Once the connection is established, you should see a popup in VSCode like the one below confirming this.

You can now use @enter or @run to debug function called in the notebook workspace exploiting the VSCode debugger.

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.

@vscedit function_name(args...)
@vscedit function_name

This macro allows opening the file location where the called method of function_name is defined on the VSCode instance connected to the calling Pluto.

The notebook has to be previosuly connected to VSCode using the @connect_vscode macro.

The synthax and functionality of this macro is mirroring the one of the @edit macro available in InteractiveUtils. When multiple methods for the called signature exists, or when the macro is called simply with a function name rather than a call signature, the macro will simply point to the first method on the MethodList return by the Base.methods function.

See also: @connect_vscode, @run, @enter

@run command

macro exported by PlutoVSCodeDebugger to allow running the debugger from a Pluto notebook in a connected VSCode instance.

It works equivalently to the @run macro available in the VSCode Julia REPL but can only be executed after connecting a running VSCode instance with @connect_vscode.

Note

The macro does not currently support debugging commands that contain other macro calls, except for the @__FILE__ and @__MODULE__ ones that are substituted during macro expansion.

So, when ran with the following example code:

@run @othermacro args...

This macro will simply throw an error because the code to run directly contains another macro.

Support for direct macro calls seem to be broken in VSCode directly. See Issue 2710 on the julia-vscode extension.

Setting breakpoints

Breakpoints set in VSCode will be respected by the @run macro, exactly like it would happen in VSCode. To simplify reaching the file position associated to a given function/method to put a breakpoint see the @vscedit macro also exported by this package.

Functions that are defined inside the notebook directly can only have breakpoints defined manually either with the @breakpoint or @bp macros. Breakpoints set up on the notebook file using the VSCode GUI will not be hit because Pluto modifies LineNumberNodes of the notebook functions so that they do not appear to be originating from the notebook file anymore at runtime.

@enter command

macro exported by PlutoVSCodeDebugger to allow entering the debugger from a Pluto notebook in a connected VSCode instance.

It works equivalently to the @enter macro available in the VSCode Julia REPL but can only be executed after connecting a running VSCode instance with @connect_vscode.

Note

The macro does not currently support debugging commands that contain other macro calls, except for the @__FILE__ and @__MODULE__ ones that are substituted during macro expansion.

So, when ran with the following example code:

@enter @othermacro args...

This macro will simply throw an error because the code to run directly contains another macro.

Support for direct macro calls seem to be broken in VSCode directly. See Issue 2710 on the julia-vscode extension.

See also: @connect_vscode, @run, @vscedit

@breakpoint f(args...) condition=nothing
@breakpoint f(args...) line condition=nothing

Break upon entry, or at the specified line number, in the method called by f(args...). Optionally supply a condition expressed in terms of the arguments and internal variables of the method. If line is supplied, it must be a literal integer.

Example

Suppose a method mysum is defined as follows, where the numbers to the left are the line number in the file:

12 function mysum(A)
13     s = zero(eltype(A))
14     for a in A
15         s += a
16     end
17     return s
18 end

Then

@breakpoint mysum(A) 15 s>10

would cause execution of the loop to break whenever s>10.

@bp

Insert a breakpoint at a location in the source code.

breakpoint(file, line, [condition])

Set a breakpoint in file at line. The argument file can be a filename, a partial path or absolute path. For example, file = foo.jl will match against all files with the name foo.jl, file = src/foo.jl will match against all paths containing src/foo.jl, e.g. both Foo/src/foo.jl and Bar/src/foo.jl. Absolute paths only matches against the file with that exact absolute path.

breakpoint(m::Method, [line], [condition])

Add a breakpoint to the file and line specified by method m. Optionally specify an absolute line number line in the source file; the default is to break upon entry at the first line of the body. Without condition, the breakpoint will be triggered every time it is encountered; the second only if condition evaluates to true. condition should be written in terms of the arguments and local variables of m.

Example

function radius2(x, y)
    return x^2 + y^2
end

m = which(radius2, (Int, Int))
breakpoint(m, :(y > x))

breakpoints()::Vector{AbstractBreakpoint}

Return an array with all breakpoints.

enable(bp::AbstractBreakpoint)

Enable breakpoint bp.

enable()

Enable all breakpoints.

disable(bp::AbstractBreakpoint)

Disable breakpoint bp. Disabled breakpoints can be re-enabled with enable.

disable()

Disable all breakpoints.

toggle(bp::AbstractBreakpoint)

Toggle breakpoint bp.

remove(bp::AbstractBreakpoint)

Remove (delete) breakpoint bp. Removed breakpoints cannot be re-enabled.

remove()

Remove all breakpoints.