Skip to content

docs: document debugging #1290

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Feb 13, 2024
Merged

docs: document debugging #1290

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e685dc8
docs: document debugging
johnnyreilly Feb 5, 2024
12d2451
fix: remove extraneous sentence
johnnyreilly Feb 5, 2024
aba983f
fix: snapshot
johnnyreilly Feb 5, 2024
a599490
feat: reduce duplication
johnnyreilly Feb 5, 2024
7097db5
fix: snapshot
johnnyreilly Feb 5, 2024
0e7587f
Merge branch 'main' into development-docs
JoshuaKGoldberg Feb 13, 2024
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
13 changes: 13 additions & 0 deletions .github/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,19 @@ Add `--watch` to keep the type checker running in a watch mode that updates the
pnpm tsc --watch
```

## Debugging

This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging.
Depending upon the type of usage, it can include debugging for unit tests _and_ for executable (or "bin") apps.

### Unit Tests

To debug a unit test, open a test file, then run _Debug Current Test File_ from the VS Code Debug panel (or press F5).

### `bin` Apps

To debug a `bin` app, add a breakpoint to your code, then run _Debug Program_ from the VS Code Debug panel (or press F5).

## Setup Scripts

As described in the `README.md` file and `docs/`, this template repository comes with three scripts that can set up an existing or new repository.
Expand Down