From 91dab7fef9cffaead9925d22bfb18b1f6c73aa2c Mon Sep 17 00:00:00 2001 From: Moritz Haase Date: Tue, 15 Mar 2022 07:47:20 +0100 Subject: [PATCH] docs: Update 'VS Code launch configuration' in contribution guide To simplify debugging via VS Code, add '--debug' argument to example launch configuration. Also, reword the hint regarding the 'console' key slightly. It has apparently been available for a long time in stable releases and is also listed in the documentation. It is however, still marked as an experimental feature, even in the current release v1.65.2. See: https://code.visualstudio.com/updates/v1_5#_launch-debug-target-in-integrated-terminal See: https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71c43a3bf..a1a4a3ea7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ If you find that the existing logs are too noisy, you can set the log level with If you keep having to do some setup steps to reproduce an issue, read the Testing section below to see how to create an integration test by recording a lazygit session. It's pretty easy! -If you want to trigger a debug session from VSCode, you can use the following snippet. Note that the 'console' key is not, at the time of writing, in a stable release. +If you want to trigger a debug session from VSCode, you can use the following snippet. Note that the `console` key is, at the time of writing, still an experimental feature. ```jsonc // .vscode/launch.json @@ -77,6 +77,9 @@ If you want to trigger a debug session from VSCode, you can use the following sn "request": "launch", "mode": "auto", "program": "main.go", + "args": [ + "--debug" + ], "console": "externalTerminal" // <-- you need this to actually see the lazygit UI in a window while debugging } ]