AckslD / nvim-dap

Debug Adapter Protocol client implementation for Neovim (>= 0.5)

DAP (Debug Adapter Protocol)

nvim-dap is a Debug Adapter Protocol client implementation for Neovim (>= 0.5). nvim-dap allows you to:

• Launch an application to debug
• Attach to running applications and debug them
• Set breakpoints and step through code
• Inspect the state of the application

Installation

• Requires Neovim (>= 0.5)
• nvim-dap is a plugin. Install it like any other Neovim plugin.
  • If using vim-plug: Plug 'mfussenegger/nvim-dap'
  • If using packer.nvim: use 'mfussenegger/nvim-dap'
• Generate the documentation for nvim-dap using :helptags ALL or :helptags <PATH-TO-PLUGIN/doc/>

You'll need to install and configure a debug adapter per language. See

• :help dap.txt
• the Debug-Adapter Installation wiki
• :help dap-adapter
• :help dap-configuration

Usage

A typical debug flow consists of:

• Setting breakpoints via :lua require'dap'.toggle_breakpoint().
• Launching debug sessions and resuming execution via :lua require'dap'.continue().
• Stepping through code via :lua require'dap'.step_over() and :lua require'dap'.step_into().
• Inspecting the state via the built-in REPL: :lua require'dap'.repl.open() or using the widget UI (:help dap-widgets)

See :help dap.txt, :help dap-mapping and :help dap-api.

Supported languages

In theory all of the languages for which a debug adapter exists should be supported.

• Available debug adapters
• nvim-dap Debug-Adapter Installation & Configuration

The Wiki is community maintained. If you got an adapter working that isn't listed yet, please extend the Wiki. If you struggle getting an adapter working, please create an issue.

Goals

• Have a basic debugger in Neovim.

• Extensibility and double as a DAP client library. This allows other plugins to extend the debugging experience. Either by improving the UI or by making it easier to debug parts of an application.

  • Examples of UI/UX extensions are nvim-dap-virtual-text and nvim-dap-ui
  • Examples for language specific extensions include nvim-jdtls and nvim-dap-python

Extensions

All known extensions are listed in the Wiki. The wiki is community maintained. Please add new extensions if you built one or if you discovered one that's not listed.

Non-Goals

• Debug adapter installations are out of scope. It's not the business of an editor plugin to re-invent a package manager. Use your system package manager. Use Nix. Use Ansible. If you disagree, check out DAPInstall.

• Vim support. It's not going to happen. Use vimspector instead.

Alternatives

• vimspector

Contributing

Contributions are welcome:

• Give concrete feedback about usability.
• Triage issues. Many of the problems people encounter are debug adapter specific.
• Improve upstream debug adapter documentation to make them more editor agnostic.
• Improve the Wiki. But please refrain from turning it into comprehensive debug adapter documentation that should go upstream.
• Write extensions.

Before making direct code contributions, please create a discussion or issue to clarify whether the change is in scope of the nvim-dap core.

Please keep pull requests focused and don't change multiple things at the same time.

Features

• launch debug adapter
• attach to debug adapter
• toggle breakpoints
• breakpoints with conditions
• logpoints
• set exception breakpoints
• step over, step into, step out
• step back, reverse continue
• Goto
• restart
• stop
• pause
• evaluate expressions
• REPL (incl. commands to show threads, frames and scopes)