feat: adapt create_term and create_and_name_term actions to work when a user has their toggleterm config's direction key set to 'float'

If the term direction is 'float' and exit_on_action is false, create the terminal in the background (term:spawn) to prevent flashes that are caused by telescope and toggleterm both being floating windows. If exit_on_action is true, treat it the same as 'horizontal' and 'vertical' toggleterm terminals, which is to exit telescope and focus the terminal.

Author: ryanmsnyder

lua/lib/actions/init.lua

@@ -1,15 +1,19 @@
 local actions = require("telescope.actions")
 local actions_state = require("telescope.actions.state")
 local toggleterm_ui = require("toggleterm.ui")
+local toggleterm_config = require("toggleterm.config")
 local util = require("util")
 local Terminal = require("toggleterm.terminal").Terminal
 
 local M = {}
 
---- Create a new terminal and open it. If exit_on_action is true, focus it.
+--- Create a new terminal and open it. If exit_on_action is true, focus it. If the term's direction is "float" and
+--- exit_on_action is false, don't automatically open the terminal upon creation to prevent flashes.
 --- @param prompt_bufnr number The buffer number of the telescope prompt.
 --- @param exit_on_action boolean Whether to exit the telescope buffer when the action executes.
 function M.create_term(prompt_bufnr, exit_on_action)
+	local float = toggleterm_config.get("direction") == "float"
+
 	-- forward declare `term` so it can be used inside `on_open_terminal`.
 	local term
 
@@ -27,26 +31,36 @@ function M.create_term(prompt_bufnr, exit_on_action)
 		end
 	end
 
-	term = Terminal:new({ on_open = on_open_terminal })
-
 	if exit_on_action then
 		actions.close(prompt_bufnr)
 
 		-- the autocommand setup in telescope/init.lua that starts insert mode on leaving the telescope buffer
 		-- won't work here since the cursor may move to a non-toggleterm buftype for a brief moment while the
 		-- toggleterm buffer is being created
 		util.start_insert_mode()
+	end
+
+	term = Terminal:new({ hidden = float, on_open = on_open_terminal })
+
+	if float and exit_on_action then
+		term:open()
+	elseif float then
+		term:spawn()
+		util.refresh_picker(prompt_bufnr, term)
+		-- remove the on_open callback to avoid potential side effects in future actions.
+		term.on_open = nil
 	else
 		util.focus_on_origin_win()
+		term:open()
 	end
-
-	term:open()
 end
 
 --- Create and name a new terminal and open it. If exit_on_action is true, focus it.
 --- @param prompt_bufnr number The buffer number of the telescope prompt.
 --- @param exit_on_action boolean Whether to exit the telescope buffer when the action executes.
 function M.create_and_name_term(prompt_bufnr, exit_on_action)
+	local float = toggleterm_config.get("direction") == "float"
+
 	local prompt = "Name terminal: "
 
 	vim.ui.input({ prompt = prompt }, function(name)
@@ -67,18 +81,28 @@ function M.create_and_name_term(prompt_bufnr, exit_on_action)
 				end
 			end
 
-			term = Terminal:new({ display_name = name, on_open = on_open_terminal })
-
 			if exit_on_action then
 				actions.close(prompt_bufnr)
+
 				-- the autocommand setup in telescope/init.lua that starts insert mode on leaving the telescope buffer
 				-- won't work here since the cursor may move to a non-toggleterm buftype for a brief moment while the
 				-- toggleterm buffer is being created
 				util.start_insert_mode()
+			end
+
+			term = Terminal:new({ display_name = name, hidden = float, on_open = on_open_terminal })
+
+			if float and exit_on_action then
+				term:open()
+			elseif float then
+				term:spawn()
+				util.refresh_picker(prompt_bufnr, term)
+				-- remove the on_open callback to avoid potential side effects in future actions.
+				term.on_open = nil
 			else
 				util.focus_on_origin_win()
+				term:open()
 			end
-			term:open()
 		end
 	end)
 end
@@ -180,6 +204,7 @@ function M.toggle_term(prompt_bufnr, exit_on_action)
 	if exit_on_action then
 		actions.close(prompt_bufnr)
 		term:toggle()
+		util.start_insert_mode()
 		return
 	end
 
@@ -196,7 +221,7 @@ function M.toggle_term(prompt_bufnr, exit_on_action)
 	util.refresh_picker(prompt_bufnr, term)
 end
 
---- Rename a terminal. If exit_on_action is true, focus it.
+--- Rename a terminal. If exit_on_action is true and the terminal is open, focus it.
 --- @param prompt_bufnr number The buffer number of the telescope prompt.
 --- @param exit_on_action boolean Whether to exit the telescope buffer when the action executes.
 function M.rename_term(prompt_bufnr, exit_on_action)

lua/util.lua

@@ -36,22 +36,23 @@ end
 --- @return table, table A tuple containing a list of toggleterm/terminal objects and a table of options that will be used for
 --- creating the telescope entries.
 function M.get_terminals()
-	local bufnrs = vim.tbl_filter(function(b)
-		return vim.api.nvim_buf_get_option(b, "filetype") == "toggleterm"
-	end, vim.api.nvim_list_bufs())
+	-- local bufnrs = vim.tbl_filter(function(b)
+	-- 	return vim.api.nvim_buf_get_option(b, "filetype") == "toggleterm"
+	-- end, vim.api.nvim_list_bufs())
 
-	if #bufnrs == 0 then
+	local terms = toggleterm.get_all(true)
+	if #terms == 0 then
 		return {}, {}
 	end
 	local terminals = {}
 	local entry_maker_opts = {}
-	local term_name_lengths, bufname_lengths = {}, {}
+	local bufnrs, term_name_lengths, bufname_lengths = {}, {}, {}
 
 	local cwd = vim.fn.expand(vim.loop.cwd())
 
-	for _, bufnr in ipairs(bufnrs) do
-		local id = vim.api.nvim_buf_get_var(bufnr, "toggle_number")
-		local term = toggleterm.get(id)
+	for _, term in ipairs(terms) do
+		-- local id = vim.api.nvim_buf_get_var(term, "toggle_number")
+		-- local term = toggleterm.get(id)
 
 		local info = vim.fn.getbufinfo(term.bufnr)[1]
 
@@ -64,6 +65,7 @@ function M.get_terminals()
 		local bufname = info.name ~= "" and info.name or "No Name"
 		bufname = Path:new(bufname):normalize(cwd) -- if bufname is inside the cwd, trim that part of the string
 
+		table.insert(bufnrs, term.bufnr)
 		table.insert(term_name_lengths, #term_name)
 		table.insert(bufname_lengths, #info.name)
 
@@ -203,7 +205,9 @@ function M.refresh_picker(prompt_bufnr, selection, deleted)
 
 	if not deleted then
 		-- Update the telescope picker's original window id to the term window id that was just created
-		current_picker.original_win_id = selection.window
+		if selection.window then
+			current_picker.original_win_id = selection.window
+		end
 	end
 end