Skip to content

Commit

Permalink
README: Add additional info on debug adapter compilation (microsoft#2402
Browse files Browse the repository at this point in the history
)

* Add additional info on debug adapter compilation

* Update Readme.md
  • Loading branch information
lggomez committed Apr 19, 2020
1 parent 1c314d4 commit 7d50d75
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/debugAdapter/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,26 @@ Please see [The Debug Adapter Protocol](https://code.visualstudio.com/blogs/2018

Clone this [repo](https://github.com/Microsoft/vscode-go) and then run `npm install`

```
```shell
git clone https://github.com/Microsoft/vscode-go
cd vscode-go
npm install
```

#### Debug Adapter compilation:
You might want to compile the debug adapter to verify your changes. Additionally, debug symbols must be updated whenever you want to set breakpoints accurately. For the vscode-go project, there is a build task available which will start the Typescript compiler in watch mode, detecting errors on code changes and updating debug symbols automatically.

The project on the debugAdapter folder level doesn´t have this task included, but the `tsc` compiler can be started manually via the following steps:

1. Install `tsc`, if you haven't done so yet:
```shell
npm install -g typescript
```
2. In the debugAdapter directory, start `tsc` in watch mode, using this extension's Typescript configuration rules:
```shell
tsc -w -p ../../
```

## Debugging the Go Debug Adapter

This is the option you would take if you want to understand or change the way the Go debug adapter interacts with delve.
Expand Down

0 comments on commit 7d50d75

Please sign in to comment.