feat: expose terminal bufnr/winnr in state module (#19)

* feat: creates windows.terminal.ignore_session configuration option
allows for creating terminal window before dap session has started

* fix: correctly position terminal if ignoring dap session

* Update README.md

Co-authored-by: Igor Lacerda <igorlfs@ufmg.br>

ref: rename config.windows.terminal.ignore_session to ...bootstrap

chore: adds comment about checking state.last_active_adapter for nil

* ref: move terminal creation logic concerning terminal edge cases to state module

ref: removes bootstrap configuration option

* chore: removes unused import and converts function to local

* ref: simplify logic for opening terminal window

Author: catgoose

README.md

@@ -199,8 +199,8 @@ return {
         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" },
+            -- `go` is known to not use the terminal.
+            hide = { "go", "some-other-adapter" },
         },
     },
 }
@@ -217,9 +217,10 @@ require("dap").defaults.fallback.switchbuf = "useopen"
 ```
 
 If you are using an adapter that does not natively support the `nvim-dap` integrated
-terminal, you can get the `winnr` and `bufnr` of the `nvim-dap-view` terminal via
-`dap-view.state` and use `vim.fn.jobstart` to start your debugger in the `nvim-dap-view`
-terminal!  An example can be found [here](https://github.com/catgoose/nvim/blob/a783e0fe931a5e417c4e3cc7e964793d895862e6/lua/config/dap/go.lua)
+terminal, but you want to use the `nvim-dap-view` terminal anyway, you can get
+the `winnr` and `bufnr` of the `nvim-dap-view` terminal via `dap-view.state` and
+use `vim.fn.jobstart` to start your debug adapter in the `nvim-dap-view` terminal!
+An example can be found [here](https://github.com/catgoose/nvim/blob/ffd88fd66ade9cad0da934e10308dbbfc76b9540/lua/config/dap/go.lua#L19-L48)
 
 ### Highlight Groups
 

lua/dap-view/events.lua

@@ -27,7 +27,11 @@ dap.listeners.before.initialize[SUBSCRIPTION_ID] = function(session, _)
     --
     -- 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 ~= adapter then
+    --
+    -- Since there has not been a `last_active_adapter` yet, we don't need to
+    -- call `delete_term_buf`, which conflicts with bootstrapping the terminal
+    -- window.  See: https://github.com/igorlfs/nvim-dap-view/issues/18
+    if state.last_active_adapter and state.last_active_adapter ~= adapter then
         term.delete_term_buf()
     end
     state.last_active_adapter = adapter

lua/dap-view/state.lua

@@ -5,6 +5,8 @@
 ---@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[]

lua/dap-view/term/init.lua

@@ -1,26 +1,21 @@
 local dap = require("dap")
 
 local state = require("dap-view.state")
-local setup = require("dap-view.setup")
 local util_buf = require("dap-view.util.buffer")
+local setup = require("dap-view.setup")
 
 local api = vim.api
 
 local M = {}
 
----@type integer?
-local term_winnr = nil
----@type integer?
-local term_bufnr = nil
-
 ---@param callback? fun(): nil
 local create_term_buf = function(callback)
-    if not term_bufnr then
-        term_bufnr = api.nvim_create_buf(true, false)
+    if not state.term_bufnr then
+        state.term_bufnr = api.nvim_create_buf(true, false)
 
-        assert(term_bufnr ~= 0, "Failed to create nvim-dap-view buffer")
+        assert(state.term_bufnr ~= 0, "Failed to create nvim-dap-view buffer")
 
-        util_buf.quit_buf_autocmd(term_bufnr, M.reset_term_buf)
+        util_buf.quit_buf_autocmd(state.term_bufnr, M.reset_term_buf)
 
         if callback then
             callback()
@@ -29,22 +24,22 @@ local create_term_buf = function(callback)
 end
 
 M.hide_term_buf = function()
-    if term_winnr and api.nvim_win_is_valid(term_winnr) then
-        api.nvim_win_hide(term_winnr)
+    if state.term_winnr and api.nvim_win_is_valid(state.term_winnr) then
+        api.nvim_win_hide(state.term_winnr)
     end
 end
 
 M.delete_term_buf = function()
-    if term_bufnr then
-        api.nvim_buf_delete(term_bufnr, { force = true })
-        term_bufnr = nil
+    if state.term_bufnr then
+        api.nvim_buf_delete(state.term_bufnr, { force = true })
+        state.term_bufnr = nil
     end
 end
 
 M.reset_term_buf = function()
     -- Only reset the buffer if there's no active session
-    if term_bufnr and not dap.session() then
-        term_bufnr = nil
+    if state.term_bufnr and not dap.session() then
+        state.term_bufnr = nil
     end
 end
 
@@ -53,30 +48,30 @@ M.open_term_buf_win = function()
     create_term_buf()
 
     local is_term_hidden = vim.tbl_contains(setup.config.windows.terminal.hide, state.last_active_adapter)
-    if dap.session() and term_bufnr and not is_term_hidden then
-        if term_winnr == nil or term_winnr and not api.nvim_win_is_valid(term_winnr) then
+    if dap.session() and state.term_bufnr and not is_term_hidden then
+        if state.term_winnr == nil or state.term_winnr and not api.nvim_win_is_valid(state.term_winnr) then
             local is_win_valid = state.winnr ~= nil and api.nvim_win_is_valid(state.winnr)
             local term_position = setup.config.windows.terminal.position
 
-            term_winnr = api.nvim_open_win(term_bufnr, false, {
+            state.term_winnr = api.nvim_open_win(state.term_bufnr, false, {
                 split = is_win_valid and term_position or "below",
                 win = is_win_valid and state.winnr or -1,
                 height = setup.config.windows.height,
             })
 
-            require("dap-view.term.options").set_options(term_winnr, term_bufnr)
+            require("dap-view.term.options").set_options(state.term_winnr, state.term_bufnr)
         end
     end
 
-    return term_winnr
+    return state.term_winnr
 end
 
 M.setup_term = function()
     create_term_buf(function()
         dap.defaults.fallback.terminal_win_cmd = function()
-            assert(term_bufnr, "Failed to get term bufnr")
+            assert(state.term_bufnr, "Failed to get term bufnr")
 
-            return term_bufnr
+            return state.term_bufnr
         end
     end)
 end