Visual Debugger Support

Open
#38 8 comments 19 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
vscode

Research direction

Review the existing VSCode debugging experience for Python scripts and Jupyter notebooks, using the linked VSCode debugging documentation as the behavioral reference. Determine how QMD files could expose breakpoints, stepping, and variable inspection in that interface; done means a QMD analysis can be debugged visually rather than requiring pdb.set_trace().

Written by the indexing model from the issue text.

Description

future vscode

QMD files currently don't have visual debugging support in the way Python scripts and Jupyter notebooks do. Without this feature, it's still much easier in VSCode to develop analyses using those other options.

In Interactive mode for Python scripts, You can click in the margin to the left of line numbers to set breakpoints. Then you can use Debug Cell to start a debugging session for that code cell. The debugger stops execution at breakpoints and allows you to step through code one line at a time and inspect variables (see Debugging for details.

The closest thing to this that I seem able to achieve is to add the line import pdb; pdb.set_trace() where I want to debug. This triggers a breakpoint where I can interrupt code flow to input commands, but I don't get to benefit from key affordances in VSCode's debugging UI.

Dominant language
TypeScript
Stars
645
Forks
62
Avg merge
17h 42m
Merged PRs (30d)
13

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from quarto-dev/quarto

All issues in quarto-dev/quarto

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.