Skip to content

Commit

Permalink
chore: doc update for Delve config
Browse files Browse the repository at this point in the history
Add an extra section to show how to configure Delve for VS Code(expand limits)
  • Loading branch information
lnu authored and JanDeDobbeleer committed Jan 13, 2021
1 parent f0558bb commit ee25365
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/docs/contributing-started.mdx
Expand Up @@ -123,6 +123,26 @@ Once the extensions are installed:
- Debug can be started by hitting F5.
- All tests can be run using the Test explorer.

### Extra tips

#### Configure Delve in VS Code

[Delve](https://github.com/go-delve/delve) config is restrictive by default(string limit especially). You can expand some limits in VS Code(`settings.json` or directly in `launch.json`):
```
"go.delveConfig": {
"dlvLoadConfig": {
"followPointers": true,
"maxVariableRecurse": 3,
"maxStringLen": 400,
"maxArrayValues": 400,
"maxStructFields": -1
},
"apiVersion": 2,
"showGlobalVariables": false
}
```

## Up Next

With everything set up, you're ready to start making changes and create your first [PR][gh-pr]!
Expand Down

0 comments on commit ee25365

Please sign in to comment.