hackwaly / ocamlearlybird

OCaml debug adapter

OCaml earlybird

OCaml debug adapter.

Installation

opam install earlybird

Usage

VS Code

See Debugging OCaml programs (experimental) in VSCode OCaml Platform README. This requires VSCode OCaml Platform 1.13 or newer.

PS. Since the integration into VSCode OCaml Platform, the old "Ocamlearlybird" VSCode extension is deprecated.

Troubleshooting

Breakpoints not hit with (lang dune 3.0) and above

Change to (lang dune 3.7) or above and add (map_workspace_root false) to your dune-project. See dune documentation for more information.

Examples

utop

Screen capture of debugging utop.

Launch configuration used:

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "test_program",
            "type": "ocaml.earlybird",
            "request": "launch",
            "stopOnEntry": true,
            "console": "integratedTerminal",
            "program": "${workspaceFolder}/_build/default/examples/interact/test_program.bc",
            "onlyDebugGlob": "<${workspaceFolder}/**/*>",
            "yieldSteps": 1024,
            "cwd": "${workspaceFolder}"
        }
    ]
}