Awesome Open Source
Awesome Open Source

DAP (Debug Adapter Protocol)

nvim-dap is a Debug Adapter Protocol client implementation for Neovim. 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

demo

Installation

  • Install nvim-dap like any other Neovim plugin:
    • git clone https://github.com/mfussenegger/nvim-dap.git ~/.config/nvim/pack/plugins/start/nvim-dap
    • Or with vim-plug: Plug 'mfussenegger/nvim-dap'
    • Or with packer.nvim: use 'mfussenegger/nvim-dap'
  • Generate the documentation for nvim-dap using :helptags ALL or :helptags <PATH-TO-PLUGIN/doc/>

Supported Neovim versions:

  • Latest nightly
  • 0.8.0 (Recommended)
  • 0.7.2

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

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.

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

Some debug adapters have language specific extensions. Using them over a manual configuration is recommended, as they're usually better maintained.

If the instructions in the wiki for a debug adapter are not working, consider that debug adapters may have made changes since the instructions were written. You may want to read the release notes of the debug adapters or try with an older version. Please update the wiki if you discover outdated examples.

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.

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.

  • nvim-dapconfig

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

Alternatives

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

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


Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Debugger (55,438
Lua (35,745
Step (21,598
Adapter (11,173
Wiki (9,833
Neovim (4,310
Breakpoint (2,579
Nvim (1,604
Neovim Plugin (741
Debug Adapter Protocol (19