feat!: specify adapters for which the terminal should be hidden (#10)

* feat!: disable terminal for selected adapters

* feat: validate user config for hidden adapters

* docs: how to disable the terminal

---------

Co-authored-by: tlj <tlj@tlj.no>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Joshua Tye <21010072+catgoose@users.noreply.github.com>

Author: 4 people

README.md

@@ -95,7 +95,7 @@ The plugin provides 4 "views" that share the same window (so there's clutter)
 
 ![repl view](https://github.com/user-attachments/assets/43caeb02-ff9e-47ea-a4c1-ab5dd30d8a3c)
 
-You can also interact with the console provided by `nvim-dap` (though, arguably, that's not a feature from `nvim-dap-view`). The console has its own window. However, its default size (height) is resized to match you `nvim-dap-view` configuration.
+You can also interact with the console provided by `nvim-dap` (though, arguably, that's not a feature from `nvim-dap-view`). The console has its own window. However, its default size (height) is resized to match your `nvim-dap-view` configuration. You can also completely [hide](#hide-terminal) it, if it's not being used.
 
 ![console](https://github.com/user-attachments/assets/0980962c-e3da-4f16-af4c-786ef7fa4b18)
 
@@ -116,6 +116,10 @@ return {
     },
     windows = {
         height = 12,
+        terminal = {
+            -- List of adapters for which the terminal should be hidden
+            hide = {},
+        },
     },
 }
 ```
@@ -169,11 +173,32 @@ vim.keymap.set("n", "<leader>v", function()
 end, { desc = "Toggle nvim-dap-view" })
 ```
 
+### Recommended Setup
+
+#### Hide Terminal
+
+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:
+
+```lua
+-- Goes into your opts table (if using lazy.nvim), otherwise goes into the setup function
+-- No need to include the "return" statement (or the outer curly braces)
+return {
+    windows = {
+        terminal = {
+            -- NOTE Don't copy paste this snippet
+            -- Use the actual names for the adapters you want to hide
+            -- `delve` is known to not use the terminal
+            hide = { "delve", "some-other-adapter" },
+        },
+    },
+}
+```
+
 ### Highlight Groups
 
 `nvim-dap-view` defines 8 highlight groups:
 
-```lua
+```
 NvimDapViewMissingData
 NvimDapViewWatchText
 NvimDapViewWatchTextChanged

lua/dap-view/actions.lua

@@ -22,11 +22,8 @@ M.toggle = function()
 end
 
 M.close = function()
-    if not dap.session() then
-        term.close_term_buf_win()
-        if vim.tbl_contains(setup.config.winbar.sections, "repl") then
-            dap.repl.close()
-        end
+    if vim.tbl_contains(setup.config.winbar.sections, "repl") then
+        dap.repl.close()
     end
     if state.winnr and api.nvim_win_is_valid(state.winnr) then
         api.nvim_win_close(state.winnr, true)
@@ -43,7 +40,7 @@ M.open = function()
 
     local bufnr = api.nvim_create_buf(false, false)
 
-    assert(bufnr ~= 0, "Failed to create dap-view buffer")
+    assert(bufnr ~= 0, "Failed to create nvim-dap-view buffer")
 
     state.bufnr = bufnr
 
@@ -54,17 +51,19 @@ M.open = function()
 
     api.nvim_buf_set_name(bufnr, globals.MAIN_BUF_NAME)
 
-    local term_winnr = term.term_buf_win_init()
+    local term_winnr = term.open_term_buf_win()
 
     local config = setup.config
 
+    local is_term_win_valid = term_winnr ~= nil and api.nvim_win_is_valid(term_winnr)
+
     local winnr = api.nvim_open_win(bufnr, false, {
-        split = "right",
-        win = term_winnr,
+        split = is_term_win_valid and "right" or "below",
+        win = is_term_win_valid and term_winnr or -1,
         height = config.windows.height,
     })
 
-    assert(winnr ~= 0, "Failed to create dap-view window")
+    assert(winnr ~= 0, "Failed to create nvim-dap-view window")
 
     state.winnr = winnr
 

lua/dap-view/config.lua

@@ -6,8 +6,12 @@ local M = {}
 ---@field default_section SectionType
 ---@field show boolean
 
+---@class TerminalConfig
+---@field hide string[] Hide the terminal for listed adapters.
+
 ---@class WindowsConfig
 ---@field height integer
+---@field terminal TerminalConfig
 
 ---@alias SectionType '"breakpoints"' | '"exceptions"' | '"watches"' | '"repl"'
 
@@ -22,6 +26,9 @@ M.config = {
     },
     windows = {
         height = 12,
+        terminal = {
+            hide = {},
+        },
     },
 }
 

lua/dap-view/events.lua

@@ -9,8 +9,28 @@ local eval = require("dap-view.watches.eval")
 
 local SUBSCRIPTION_ID = "dap-view"
 
-dap.listeners.before.initialize[SUBSCRIPTION_ID] = function()
-    term.term_buf_win_init()
+dap.listeners.before.initialize[SUBSCRIPTION_ID] = function(session, _)
+    -- When initializing a new session, there might a leftover terminal buffer
+    -- Usually, this wouldn't be a problem, but it can cause inconsistencies when starting a session that
+    --
+    -- (A) Doesn't use the terminal, after a session that does
+    -- The problem here is that the terminal could be used if it was left open from the earlier session
+    --
+    -- (B) Uses the terminal, after a session that doesn't
+    -- The terminal wouldn't show up, since it's hidden
+    --
+    -- To handle these scenarios, we have to close the terminal buffer
+    -- However, if we always close the terminal, dap-view will be shifted very quickly (if open),
+    -- causing a flickering effect.
+    --
+    -- To address that, we only close the terminal if the new session has a different adapter
+    -- (which should cover most scenarios where the flickering would occur)
+    if state.last_active_adapter ~= session.config.type then
+        term.clear_term_bufnr()
+    end
+    state.last_active_adapter = session.config.type
+
+    term.open_term_buf_win()
 end
 
 dap.listeners.after.setBreakpoints[SUBSCRIPTION_ID] = function()

lua/dap-view/setup/validate/windows.lua

@@ -1,10 +1,17 @@
 local M = {}
 
+local validate = require("dap-view.setup.validate.util").validate
+
 ---@param config WindowsConfig
 function M.validate(config)
-    require("dap-view.setup.validate.util").validate("windows", {
+    validate("windows", {
         height = { config.height, "number" },
+        terminal = { config.terminal, "table" },
     }, config)
+
+    validate("windows.terminal", {
+        hide = { config.terminal.hide, "table" },
+    }, config.terminal)
 end
 
 return M

lua/dap-view/state.lua

@@ -5,20 +5,13 @@
 ---@class State
 ---@field bufnr? integer
 ---@field winnr? integer
----@field term_bufnr? integer
----@field term_winnr? integer
+---@field last_active_adapter? string
 ---@field current_section? SectionType
 ---@field exceptions_options? ExceptionsOption[]
 ---@field watched_expressions string[]
 ---@field expression_results string[]
 ---@field updated_evaluations boolean[]
 local M = {
-    bufnr = nil,
-    winnr = nil,
-    term_bufnr = nil,
-    term_winnr = nil,
-    current_section = nil,
-    exceptions_options = nil,
     watched_expressions = {},
     expression_results = {},
     updated_evaluations = {},

lua/dap-view/term/init.lua

@@ -8,50 +8,70 @@ local api = vim.api
 
 local M = {}
 
+---@type integer?
+local term_winnr = nil
+---@type integer?
+local term_bufnr = nil
+
+M.clear_term_bufnr = function()
+    if term_bufnr then
+        api.nvim_buf_delete(term_bufnr, { force = true })
+        term_bufnr = nil
+    end
+end
+
 M.close_term_buf_win = function()
-    if state.term_winnr then
-        api.nvim_win_close(state.term_winnr, true)
-        state.term_winnr = nil
+    if term_winnr and api.nvim_win_is_valid(term_winnr) then
+        api.nvim_win_close(term_winnr, true)
+        term_winnr = nil
     end
-    if state.term_bufnr then
-        api.nvim_buf_delete(state.term_bufnr, { force = true })
-        state.term_bufnr = nil
+    -- Only delete the buffer if there's no active session
+    if term_bufnr and not dap.session() then
+        api.nvim_buf_delete(term_bufnr, { force = true })
+        term_bufnr = nil
     end
 end
 
-M.term_buf_win_init = function()
-    -- Should NOT close the term buffer, since it contains the data from the session
+---@return integer?
+M.open_term_buf_win = function()
+    -- When (re)opening the terminal we should NOT close it,
+    -- since it's the default standard output for most adapters
+    -- Therefore, closing it could delete useful information from the last session
 
-    if not state.term_bufnr then
-        local term_bufnr = api.nvim_create_buf(true, false)
+    if not term_bufnr then
+        term_bufnr = api.nvim_create_buf(true, false)
 
-        assert(term_bufnr ~= 0, "Failed to create dap-view buffer")
+        assert(term_bufnr ~= 0, "Failed to create nvim-dap-view buffer")
 
-        state.term_bufnr = term_bufnr
+        util_buf.quit_buf_autocmd(term_bufnr, M.close_term_buf_win)
     end
 
-    if not state.term_winnr then
-        local config = setup.config
-        local term_winnr = api.nvim_open_win(state.term_bufnr, false, {
-            split = "below",
-            win = -1,
-            height = config.windows.height,
-        })
+    local config = setup.config
 
-        assert(term_winnr ~= 0, "Failed to create dap-view terminal window")
+    if not term_winnr then
+        for _, adapter in ipairs(config.windows.terminal.hide) do
+            dap.defaults[adapter].terminal_win_cmd = function()
+                return term_bufnr
+            end
+        end
 
-        state.term_winnr = term_winnr
+        dap.defaults.fallback.terminal_win_cmd = function()
+            local is_win_valid = state.winnr ~= nil and api.nvim_win_is_valid(state.winnr)
+            term_winnr = api.nvim_open_win(term_bufnr, false, {
+                split = is_win_valid and "left" or "below",
+                win = is_win_valid and state.winnr or -1,
+                height = config.windows.height,
+            })
 
-        require("dap-view.term.options").set_options()
+            assert(term_winnr ~= 0, "Failed to create nvim-dap-view terminal window")
 
-        util_buf.quit_buf_autocmd(state.term_bufnr, M.close_term_buf_win)
+            require("dap-view.term.options").set_options(term_winnr, term_bufnr)
 
-        dap.defaults.fallback.terminal_win_cmd = function()
-            return state.term_bufnr, state.term_winnr
+            return term_bufnr, term_winnr
         end
     end
 
-    return state.term_winnr
+    return term_winnr
 end
 
 return M

lua/dap-view/term/options.lua

@@ -1,9 +1,9 @@
 local M = {}
 
-local state = require("dap-view.state")
-
-M.set_options = function()
-    local win = vim.wo[state.term_winnr][0]
+---@param winnr integer
+---@param bufnr integer
+M.set_options = function(winnr, bufnr)
+    local win = vim.wo[winnr][0]
     win.scrolloff = 0
     win.wrap = false
     win.number = false
@@ -13,7 +13,7 @@ M.set_options = function()
     win.foldcolumn = "0"
     win.winfixbuf = true
 
-    local buf = vim.bo[state.term_bufnr]
+    local buf = vim.bo[bufnr]
     buf.filetype = "dap-view-term"
     buf.buftype = "nofile"
 end