Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 how to use the debugger #127

Merged
merged 2 commits into from
Apr 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions entries/debugging.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Debugging in VS Code"
---

In each Seedcase software repository is a file called
`.vscode/launch.json` with a debugger called `"seedcase-debugger"`. This
file gives us the ability to set break points and assess variables and
views at these break points by using the built-in "Run and Debug"
feature in VS Code.

To use the debugger:

1. Click the "Run and Debug" icon on the sidebar menu in VS Code
2. Check that it says "seedcase-debugger" in the top, next to the
"Play" icon button (don't click it yet, if you want to add break points)
3. Set break points where you want the code to stop by going to the
script you want, and click at the left side of the line (a red dot
will appear)
4. Then, in the "Run and debug" tab, click "Play". The debug console
will open. Follow the local host link (as when running
`just start-app`) and go to the page you want to debug. The code
will stop at your break point(s) and you can inspect the variables
at that stage in the tab.