BUG: UI not showing all the time

[GaryLiuGTA]

Did you check docs and existing issues?

• I have read all the docs.
• I have searched the existing issues.

Neovim version (nvim -v)

0.11.1

Operating system/version

Ubuntu 24.04

Describe the bug

The UI only showed one time, and never shows properly. And when it shows, cannot quit with 'dq', so I cannot 'undo' with 'u'.

now, every time I start a new debug session, it shows as below:

a blank window under coding script and a terminal buffer appears. The cursor color changes though.

I used nvim-dap-ui with LazyVim default settings before and it worked well.
and the breakpoint icons also changed to letter B or C (conditional breakpoints), and it changed back after I removed debugmaster and re-enabled nvim-dap-ui

Not sure if that is due to my settings or it is a bug from debugmaster.

Steps To Reproduce

Here is my settings now:

return {
    { "rcarriga/nvim-dap-ui", enabled = false },

    {
        "mfussenegger/nvim-dap",
        config = function()
            local dap = require("dap")
        end,
    },
    {
        "miroshQa/debugmaster.nvim",
        config = function()
            local dm = require("debugmaster")
            vim.keymap.set({ "n", "v" }, "<leader>dd", dm.mode.toggle, { nowait = true, desc = "Toggle DebugMaster" })
        end,
    },
}

Expected Behavior

every time, the debugmaster UI can shows properly when pressed dd.

Repro (Ignore if not applicable or if the issue is easily reproducible.)

-- set stdpaths to the current directory
local initlua_root = vim.fn.fnamemodify(debug.getinfo(1).short_src, ":p:h")
for _, name in ipairs { "config", "data", "state", "cache" } do
  vim.env[("XDG_%s_HOME"):format(name:upper())] = initlua_root .. "/" .. name
end

-- bootstrap lazy
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.uv.fs_stat(lazypath) then
  local lazyrepo = "https://github.com/folke/lazy.nvim.git"
  vim.fn.system({ "git", "clone", "--filter=blob:none", "--branch=stable", lazyrepo, lazypath })
end
vim.opt.rtp:prepend(lazypath)


vim.g.mapleader = " "
require("lazy").setup({
  spec = {
      {
        "mfussenegger/nvim-dap",
        config = function()
          local dap = require("dap")
          -- Configure your debug adapters here
          -- https://github.com/mfussenegger/nvim-dap/blob/master/doc/dap.txt
        end,
      },
      {
        "miroshQa/debugmaster.nvim",
        config = function()
          local dm = require("debugmaster")
          vim.keymap.set({ "n", "v" }, "<leader>d", dm.mode.toggle, { nowait = true })
          vim.keymap.set("t", "<C-/>", "<C-\\><C-n>", { desc = "Exit terminal mode" })
        end
      }
  },
})

[MironPascalCaseFan]

1. in lazy.nvim when you override nvim-dap spec it disables the default nvim-dap configuration: https://www.lazyvim.org/extras/dap/core#nvim-dap. This deafult configuration was responsible for automatically setup configs for debug adapters and overriding default nvim-dap debug signs (exactly for this reason you see letters now instead nerd icons)
   So you shoulprobably need use something like this instead your code above (remove nvim-dap spec):

return {
    { "rcarriga/nvim-dap-ui", enabled = false },
    {
        "miroshQa/debugmaster.nvim",
        config = function()
            local dm = require("debugmaster")
            vim.keymap.set({ "n", "v" }, "<leader>dd", dm.mode.toggle, { nowait = true, desc = "Toggle DebugMaster" })
        end,
    },
}

2. About broken UI: Can you provide a screen recording so I can understand you more clearly? It’s pretty easy to record your screen using OBS, and then you just need to drag and drop it here.

[MironPascalCaseFan]

@GaryLiuGTA I updated the suggested configuration example in the README. Just copy-paste it, and it should work with LazyVim without any issues.

[GaryLiuGTA]

Thank you very much for the quick response.

yes, the icons are back after removing the nvim-dap sepc.

Below is my screen recording, you can see after I started the debug session, it has weird window and buffer. And these did not disappear after I terminate the debug session. and the UI can still be called out with shortcut key u within and after debug session.

[MironPascalCaseFan]

@GaryLiuGTA I got it. The trick is that this plugin really initializes itself only on the first debug mode activation. It overrides the nvim-dap default terminal_win_cmd function on initialization to be able to capture the terminal created by nvim-dap and display it in the UI. But in your case, you start debugging without enabling debug mode first

So, you should start debugging only after activating debug mode at least once. I recommend mapping debug mode activation to leader+m ([m]ode) or leader>+; so it was more convenient.

vim.keymap.set({ "n", "v" }, "<leader>m", dm.mode.toggle, { nowait = true, desc = "Toggle DebugMaster" })

After that, instead of using leader+db + leader+dc, use leader+m to enter debug mode, then t to set a breakpoint, and c to start the session.

So, in general, you’re not supposed to start debugging and control it without this plugin—it already provides all the necessary keymaps. So you should just enter debug mode, then use the shortcuts available in this mode (t – toggle breakpoint, c – launch or continue, etc). Don’t use LazyVim’s default leader+d..

[GaryLiuGTA]

Thank you very much for your help.! Now it is started and ran as expected. But the keybinding seems still not released properly after debug session terminated. the UI still pop out when I press u, and not able to undo. I also tried dq to quit, but not working. Any suggestions?

[GaryLiuGTA]

ah, I know I have to manually exit by m. I think it should listen to the event and automatically exit when the session terminated or disconnected? or open when the dap session start, Like dap-ui:

[GaryLiuGTA]

debugmaster only has toggle method. if it also has open and close methods, then I guess we do the same and it can be triggered automatically by DAP start and terminate?