minimalistic nvim-dap-ui alternative
https://github.com/user-attachments/assets/01c461f7-b77b-4232-bed5-4630f3e7c039
[!WARNING]
Requires neovim 0.11+
return {
{
"igorlfs/nvim-dap-view",
opts = {},
},
}
For a better experience, consider adding nvim-dap-view
as a dependency for
nvim-dap
(instead of declaring it as a standalone plugin)
By default, when launching a session, nvim-dap
's terminal window takes half
the screen. As a saner default, nvim-dap-view
hijacks the terminal window
(even if not invoked), making the split take only 12 (configurable) lines.
-- Your nvim-dap config
return {
{
"mfussenegger/nvim-dap",
dependencies = {
{ "igorlfs/nvim-dap-view", opts = {} },
...,
},
...,
},
}
[!NOTE]
nvim-dap-view
heavily relies on the winbar option. If you're using a plugin that overrides it, consider disabling the plugin fornvim-dap-view
buffers (e.g., lualine)
The plugin provides 6 "views" that share the same window (so there's clutter)
<CR>
<CR>
subtle
(hidden) frames with t
<CR>
You can also interact with the console, which is also provided by nvim-dap
. By the default, the console has its own window, but it can be configured to be shown with the other views. See details on the default config section.
The console's default size (height) is resized to match your nvim-dap-view
configuration. You can also either completely hide it (if it's not being used at all) or hide it only during session initialization.
You can also enable the control bar which exposes some clickable buttons by settings winbar.controls.enable
.
The control bar is fully customizable, checkout the options on default configuration section.
[!NOTE] Icons are using
Codicons
glyphs so it requires a Nerd Font
return {
winbar = {
show = true,
-- You can add a "console" section to merge the terminal with the other views
sections = { "watches", "scopes", "exceptions", "breakpoints", "threads", "repl" },
-- Must be one of the sections declared above
default_section = "watches",
headers = {
breakpoints = "Breakpoints [B]",
scopes = "Scopes [S]",
exceptions = "Exceptions [E]",
watches = "Watches [W]",
threads = "Threads [T]",
repl = "REPL [R]",
console = "Console [C]",
},
controls = {
enabled = false,
position = "right",
buttons = {
"play",
"step_into",
"step_over",
"step_out",
"step_back",
"run_last",
"terminate",
"disconnect",
},
icons = {
pause = "",
play = "",
step_into = "",
step_over = "",
step_out = "",
step_back = "",
run_last = "",
terminate = "",
disconnect = "",
},
custom_buttons = {},
},
},
windows = {
height = 12,
terminal = {
-- 'left'|'right'|'above'|'below': Terminal position in layout
position = "left",
-- List of debug adapters for which the terminal should be ALWAYS hidden
hide = {},
-- Hide the terminal when starting a new session
start_hidden = false,
},
},
-- Controls how to jump when selecting a breakpoint or navigating the stack
switchbuf = "usetab,newtab",
}
Start a regular debugging session. When desired, you can use :DapViewOpen
to
start the plugin. You can switch to a view (section) using the letter outlined
in the 'winbar'
(e.g., B
for the breakpoints view).
The breakpoints view, the exceptions view and the scopes view only have 1
mapping: <CR>
. It jumps to a breakpoint, toggles an exception filter, and
expands a variable, respectively. The watches view comes with 5 mappings:
i
to insert a new expressione
to edit an expressionc
to copy an expression or variables
to change the value of an expression or variabled
to delete an expressionThough, the preferred way of adding a new expression is using the
:DapViewWatch
command. In normal mode, it adds the variable under the cursor
to the watch list. The threads view has 2 mappings:
<CR>
jumps to a location in the call stackt
toggles subtle framesWhen you finish your session, you can use :DapViewClose
to close the
nvim-dap-view
window.
In total, there are 6 commands:
DapViewOpen
DapViewClose
DapViewToggle
DapViewWatch
DapViewJump [view]
DapViewShow [view]
You can :DapViewJump [view]
to jump directly to a view, from any window. For instance, to jump to the REPL, you can use :DapViewJump repl
.
Additionally, you can use DapViewClose!
and DapViewToggle!
to also hide the
terminal window, if you'd rather have a tidy view.
If you prefer using lua functions, I got you covered! The following provide the same functionality as above:
require("dap-view").open()
require("dap-view").close()
require("dap-view").close(true) -- Same as `DapViewClose!`
require("dap-view").toggle()
require("dap-view").toggle(true) -- Same as `DapViewToggle!`
require("dap-view").add_expr()
-- Can be used to jump to a specific view, from any window
require("dap-view").jump_to_view("[view]")
-- Can be used to show to a specific view
-- If the specified view is the current one, jump to its window instead
require("dap-view").show_view("[view]")
nvim-dap-view
doesn't define any keybindings (outside its own buffer, of
course). An example for the toggle functionality, using the lua API:
vim.keymap.set("n", "<leader>v", function()
require("dap-view").toggle()
end, { desc = "Toggle nvim-dap-view" })
If you find yourself constantly toggling nvim-dap-view
once a session starts and then closing on session end, you might want to add the following snippet to your configuration:
local dap, dv = require("dap"), require("dap-view")
dap.listeners.before.attach["dap-view-config"] = function()
dv.open()
end
dap.listeners.before.launch["dap-view-config"] = function()
dv.open()
end
dap.listeners.before.event_terminated["dap-view-config"] = function()
dv.close()
end
dap.listeners.before.event_exited["dap-view-config"] = function()
dv.close()
end
Some debug adapters don't use the integrated terminal (console). To avoid having a useless window lying around, you can completely hide the terminal for them. To achieve that, add the following snippet to your nvim-dap-view
setup:
-- Goes into your opts table (if using lazy.nvim), otherwise goes into the setup function
-- No need to include the "return" statement
return {
windows = {
terminal = {
-- NOTE Don't copy paste this snippet
-- Use the actual names for the adapters you want to hide
-- `go` is known to not use the terminal.
hide = { "go", "some-other-adapter" },
},
},
}
When setting windows.terminal.position
to right
, nvim-dap-view
's main window may be used to display the current frame (after execution stops), because nvim-dap
defaults to the global switchbuf
setting. To address this, update your switchbuf
configuration. For instance:
require("dap").defaults.fallback.switchbuf = "useopen" -- See :h dap-defaults to learn more
When jumping via nvim-dap-view
(to a breakpoint or to a frame in the stack), nvim-dap-view
uses its own switchbuf
, which supports a subset of the default neovim options ("newtab", "useopen", "usetab" and "uselast"). You can customize it with:
-- Goes into your opts table (if using lazy.nvim), otherwise goes into the setup function
-- No need to include the "return" statement
return {
switchbuf = "useopen",
}
:DapViewWatch
expands the <cexpr>
under the cursor (see :h <cexpr>
). By default, this setting works really well for C-like languages, but it can be cumbersome for other languages. To handle that, you can tweak the value for the iskeyword
option (see :h iskeyword
).
nvim-dap-view
defines 28 highlight groups linked to (somewhat) reasonable defaults, but they may look odd with your colorscheme. If the links aren't defined, no highlighting will be applied. To fix that, you have to manually define the highlight groups (see :h nvim_set_hl()
). Consider contributing to your colorscheme by sending a PR to add support to nvim-dap-view
!
Highlight Group | Default link |
---|---|
NvimDapViewMissingData |
DapBreakpoint |
NvimDapViewExceptionFilterEnabled |
DiagnosticOk |
NvimDapViewExceptionFilterDisabled |
DiagnosticError |
NvimDapViewFileName |
qfFileName |
NvimDapViewLineNumber |
qfLineNr |
NvimDapViewSeparator |
Comment |
NvimDapViewThread |
Tag |
NvimDapViewThreadStopped |
Conditional |
NvimDapViewTab |
TabLine |
NvimDapViewTabSelected |
TabLineSel |
NvimDapViewControlNC |
Comment |
NvimDapViewControlPlay |
Keyword |
NvimDapViewControlPause |
Boolean |
NvimDapViewControlStepInto |
Function |
NvimDapViewControlStepOut |
Function |
NvimDapViewControlStepOver |
Function |
NvimDapViewControlStepBack |
Function |
NvimDapViewControlRunLast |
Keyword |
NvimDapViewControlTerminate |
DapBreakpoint |
NvimDapViewControlDisconnect |
DapBreakpoint |
NvimDapViewWatchExpr |
Identifier |
NvimDapViewWatchError |
DiagnosticError |
NvimDapViewWatchUpdated |
DiagnosticVirtualTextWarn |
NvimDapViewBoolean |
Boolean |
NvimDapViewString |
String |
NvimDapViewNumber |
Number |
NvimDapViewFloat |
Float |
NvimDapViewFunction |
Function |
nvim-dap-view
sets the following filetypes:
Window | Filetype |
---|---|
watches, exceptions, breakpoints, scopes, threads | dap-view |
terminal | dap-view-term |
They can be used to override buffer and window options set by nvim-dap-view
.
If the REPL is enabled, the dap-repl
filetype (which is set by nvim-dap
) is also used. If you wish to consistently override the plugin's behavior, be sure to also include the dap-repl
filetype in your autocommand.
Map q to quit in nvim-dap-view
filetypes:
vim.api.nvim_create_autocmd({ "FileType" }, {
pattern = { "dap-view", "dap-view-term", "dap-repl" }, -- dap-repl is set by `nvim-dap`
callback = function(evt)
vim.keymap.set("n", "q", "<C-w>q", { buffer = evt.buf })
end,
})
nvim-dap-view
provides some default buttons for the control bar, but you can also add your own. To do that, in the controls
table you can use the custom_buttons
table to declare your new button and then add it at the position you want in the buttons
list.
A custom button has 2 methods:
render
returning a string used to display the button (typically an emoji or a NerdFont glyph wrapped in an highlight group)action
a function that will be executed when the button is clicked. The function receives 3 arguments:clicks
the number of clicksbutton
the button clicked (l
, r
, m
)modifiers
a string with the modifiers pressed (c
for control
, s
for shift
, a
for alt
and m
for meta
)See the @ N
section in :help statusline
for the complete specifications of a click handler.
An example adding 2 buttons:
fun
: the most basic button possible, just prints "🎊" when clickedterm_restart
: an hybrid button that acts as a stop/restart button. If the stop button is triggered by anything else than a single left click (middle click, right click, double click or click with a modifier), it will disconnect the session instead.-- No need to include the "return" statement
return {
winbar = {
controls = {
enabled = true,
buttons = { "play", "step_into", "step_over", "step_out", "term_restart", "fun" },
custom_buttons = {
fun = {
render = function()
return "🎉"
end,
action = function()
vim.print("🎊")
end,
},
-- Stop/Restart button
-- Double click, middle click or click with a modifier disconnect instead of stop
term_restart = {
render = function()
local session = require("dap").session()
local group = session and "ControlTerminate" or "ControlRunLast"
local icon = session and "" or ""
return "%#NvimDapView" .. group .. "#" .. icon .. "%*"
end,
action = function(clicks, button, modifiers)
local dap = require("dap")
local alt = clicks > 1 or button ~= "l" or modifiers:gsub(" ", "") ~= ""
if not dap.session() then
dap.run_last()
elseif alt then
dap.disconnect()
else
dap.terminate()
end
end,
},
},
},
},
}
Missing something? Create an issue with a feature request!
nvim-dap
. We
could use a workaround, but a new API is
plannedquicker.nvim
;nvim-dap
:nvim-dap
.'winbar'
to handle multiple views.[^1]: Filters depend on the debug adapter's capabilities [^2]: From treesitter and extmarks (e.g., semantic highlighting from LSP)