Requirements
Install haskell-dap, ghci-dap, haskell-debug-adapter at once.
> stack install haskell-dap ghci-dap haskell-debug-adapter
>
> ghci-dap --version
[DAP][INFO] start ghci-dap-0.0.XX.0.
The Glorious Glasgow Haskell Compilation System, version 8.X.X
>
> haskell-debug-adapter --version
VERSION: haskell-debug-adapter-0.0.XX.0
>
Limitations
- Supported ghc-8.8, ghc-8.6
- The source file extension must be ".hs"
- Can not use STDIN handle while debugging.
Features
Quickstart
Shortcut keys
- F5 : start / continue debugging
- F6 : show command menu (for stack watch)
- Shift + F6 : stop stack watch
- F7 : stack clean & build
- F8 : stack test
- F9 : put a breakpoint on the current line
- Shift + F9 : put a breakpoint on the current column
- F10 : step next
- F11 : step into
Configuration
see sample files.
.vscode/launch.json
| NAME |
REQUIRED OR OPTIONAL |
DEFAULT SETTING |
DESCRIPTION |
| startup |
required |
${workspaceRoot}/test/Spec.hs |
debug startup file, will be loaded automatically. |
| startupFunc |
optional |
"" (empty string) |
debug startup function, will be run instead of main function. |
| startupArgs |
optional |
"" (empty string) |
arguments for startup function. set as string type. |
| stopOnEntry |
required |
false |
stop or not after debugger launched. |
| mainArgs |
optional |
"" (empty string) |
main arguments. |
| ghciPrompt |
required |
H>>= |
ghci command prompt string. |
| ghciInitialPrompt |
optional |
"Prelude> " |
initial pormpt of ghci. set it when using custom prompt. e.g. set in .ghci |
| ghciCmd |
required |
stack ghci --test --no-load --no-build --main-is TARGET --ghci-options -fprint-evld-with-show |
launch ghci command, must be Prelude module loaded. For example, "ghci -i${workspaceRoot}/src", "cabal exec -- ghci -i${workspaceRoot}/src" |
| ghciEnv |
required |
[] |
Environment variables for ghci exectution. |
| logFile |
required |
${workspaceRoot}/.vscode/phoityne.log |
internal log file. |
| logLevel |
required |
WARNING |
internal log level. |
| forceInspect |
required |
false |
Inspect scope variables force. |
.vscode/tasks.json
| TASK NAME |
REQUIRED OR OPTIONAL |
DEFAULT SETTING |
DESCRIPTION |
| stack build |
required |
stack build |
task definition for F6 shortcut key. |
| stack clean & build |
required |
stack clean && stack build |
task definition for F7 shortcut key. |
| stack test |
required |
stack test |
task definition for F8 shortcut key. |
| stack watch |
required |
stack build --test --no-run-tests --file-watch |
task definition for F6 shortcut key. |
| |
