Skip to content

Commit bebe7af

Browse files
docs: document debugging (#1290)
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖. Please fill out all fields below and make sure each item is true and [x] checked. Otherwise we may not be able to review your PR. --> ## PR Checklist - [x] Addresses an existing open issue: fixes #1217 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview This PR introduces documentation for debugging --------- Co-authored-by: Josh Goldberg ✨ <[email protected]>
1 parent 105ff60 commit bebe7af

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

.github/DEVELOPMENT.md

+13
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,19 @@ Add `--watch` to keep the type checker running in a watch mode that updates the
9999
pnpm tsc --watch
100100
```
101101

102+
## Debugging
103+
104+
This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging.
105+
Depending upon the type of usage, it can include debugging for unit tests _and_ for executable (or "bin") apps.
106+
107+
### Unit Tests
108+
109+
To debug a unit test, open a test file, then run _Debug Current Test File_ from the VS Code Debug panel (or press F5).
110+
111+
### `bin` Apps
112+
113+
To debug a `bin` app, add a breakpoint to your code, then run _Debug Program_ from the VS Code Debug panel (or press F5).
114+
102115
## Setup Scripts
103116

104117
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.

0 commit comments

Comments
 (0)