refactor: move util to lib directory and rename it to utils/init.lua

Expose utils/init.lua so users can access it if needed when making custom actions (i.e. local utils = require('toggleterm-manager').utils)

Author: ryanmsnyder

lua/lib/actions/init.lua

@@ -2,7 +2,7 @@ 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 utils = require("lib.utils")
 local Terminal = require("toggleterm.terminal").Terminal
 
 local M = {}
@@ -23,8 +23,8 @@ function M.create_term(prompt_bufnr, exit_on_action)
 				-- set origin window to current term before switching back to telescope
 				-- this ensures the cursor is moved to the correct term window after closing a term
 				toggleterm_ui.set_origin_window()
-				util.focus_on_telescope(prompt_bufnr)
-				util.refresh_picker(prompt_bufnr, term)
+				utils.focus_on_telescope(prompt_bufnr)
+				utils.refresh_picker(prompt_bufnr, term)
 				-- remove the on_open callback to avoid potential side effects in future actions.
 				term.on_open = nil
 			end)
@@ -37,7 +37,7 @@ function M.create_term(prompt_bufnr, exit_on_action)
 		-- 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()
+		utils.start_insert_mode()
 	end
 
 	term = Terminal:new({ hidden = float, on_open = on_open_terminal })
@@ -46,11 +46,11 @@ function M.create_term(prompt_bufnr, exit_on_action)
 		term:open()
 	elseif float then
 		term:spawn()
-		util.refresh_picker(prompt_bufnr, term)
+		utils.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()
+		utils.focus_on_origin_win()
 		term:open()
 	end
 end
@@ -64,7 +64,7 @@ function M.create_and_name_term(prompt_bufnr, exit_on_action)
 	local prompt = "Name terminal: "
 
 	vim.ui.input({ prompt = prompt }, function(name)
-		util.clear_command_line()
+		utils.clear_command_line()
 		if name and #name > 0 then
 			local term
 			local function on_open_terminal()
@@ -73,8 +73,8 @@ function M.create_and_name_term(prompt_bufnr, exit_on_action)
 						-- set origin window to current term before switching back to telescope
 						-- this ensures the cursor is moved to the correct term window after closing a term
 						toggleterm_ui.set_origin_window()
-						util.focus_on_telescope(prompt_bufnr)
-						util.refresh_picker(prompt_bufnr, term)
+						utils.focus_on_telescope(prompt_bufnr)
+						utils.refresh_picker(prompt_bufnr, term)
 						-- remove the on_open callback to avoid potential side effects in future actions.
 						term.on_open = nil
 					end)
@@ -87,7 +87,7 @@ function M.create_and_name_term(prompt_bufnr, exit_on_action)
 				-- 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()
+				utils.start_insert_mode()
 			end
 
 			term = Terminal:new({ display_name = name, hidden = float, on_open = on_open_terminal })
@@ -96,11 +96,11 @@ function M.create_and_name_term(prompt_bufnr, exit_on_action)
 				term:open()
 			elseif float then
 				term:spawn()
-				util.refresh_picker(prompt_bufnr, term)
+				utils.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()
+				utils.focus_on_origin_win()
 				term:open()
 			end
 		end
@@ -120,7 +120,7 @@ function M.rename_term(prompt_bufnr, exit_on_action)
 
 	local prompt = string.format("Rename terminal %s: ", selection.term_name)
 	vim.ui.input({ prompt = prompt }, function(name)
-		util.clear_command_line()
+		utils.clear_command_line()
 		if name and #name > 0 then
 			-- rename terminal within toggleterm
 			term.display_name = name
@@ -130,10 +130,10 @@ function M.rename_term(prompt_bufnr, exit_on_action)
 				term:focus()
 			else
 				local current_picker = actions_state.get_current_picker(prompt_bufnr)
-				local finder, new_row_number = util.create_finder(term.id)
+				local finder, new_row_number = utils.create_finder(term.id)
 				current_picker:refresh(finder, { reset_prompt = false })
 
-				util.set_selection_row(current_picker, new_row_number)
+				utils.set_selection_row(current_picker, new_row_number)
 			end
 		end
 	end)
@@ -156,17 +156,17 @@ function M.open_term(prompt_bufnr, exit_on_action)
 			term:open()
 		end
 		term:focus()
-		util.start_insert_mode()
+		utils.start_insert_mode()
 		return
 	end
 
-	util.focus_on_origin_win()
+	utils.focus_on_origin_win()
 	if not term:is_open() then
 		term:open()
 	end
 
-	util.focus_on_telescope(prompt_bufnr)
-	util.refresh_picker(prompt_bufnr, term)
+	utils.focus_on_telescope(prompt_bufnr)
+	utils.refresh_picker(prompt_bufnr, term)
 end
 
 --- Toggle a terminal open or closed. If toggling open and exit_on_action is true, focus it.
@@ -185,11 +185,11 @@ function M.toggle_term(prompt_bufnr, exit_on_action)
 	if exit_on_action then
 		actions.close(prompt_bufnr)
 		term:toggle()
-		util.start_insert_mode()
+		utils.start_insert_mode()
 		return
 	end
 
-	util.focus_on_origin_win()
+	utils.focus_on_origin_win()
 	if term:is_open() then
 		term:close()
 		current_picker.original_win_id = toggleterm_ui.get_origin_window()
@@ -198,8 +198,8 @@ function M.toggle_term(prompt_bufnr, exit_on_action)
 		current_picker.original_win_id = term.window
 	end
 
-	util.focus_on_telescope(prompt_bufnr)
-	util.refresh_picker(prompt_bufnr, term)
+	utils.focus_on_telescope(prompt_bufnr)
+	utils.refresh_picker(prompt_bufnr, term)
 end
 
 --- Delete a terminal.
@@ -226,17 +226,17 @@ function M.delete_term(prompt_bufnr, exit_on_action)
 	-- and causes telescope to exit. See toggleterm's terminal.lua:__handle_exit and ui.lua:close_split.
 	term.close_on_exit = false
 
-	util.focus_on_origin_win()
+	utils.focus_on_origin_win()
 
 	local force = vim.api.nvim_buf_get_option(selection.bufnr, "buftype") == "terminal"
 
-	util.delete_buffer(selection.bufnr, force)
+	utils.delete_buffer(selection.bufnr, force)
 
 	toggleterm_ui.set_origin_window()
 
-	util.focus_on_telescope(prompt_bufnr)
+	utils.focus_on_telescope(prompt_bufnr)
 
-	util.refresh_picker(prompt_bufnr, selection, true)
+	utils.refresh_picker(prompt_bufnr, selection, true)
 end
 
 return M

lua/lib/telescope/init.lua

@@ -1,7 +1,7 @@
 local pickers = require("telescope.pickers")
 local telescope_actions = require("telescope.actions")
 local conf = require("telescope.config").values
-local util = require("util")
+local utils = require("lib.utils")
 
 --- Create autocommand to enter insert mode when the cursor leaves the telescope buffer.
 --- Useful for actions that are called with exit_on_action set to false b/c it allows the user
@@ -20,7 +20,7 @@ local function telescope_leave_autocmd(picker)
 				local picker_orig_win_bufnr = vim.fn.winbufnr(picker.original_win_id)
 				local buftype = vim.api.nvim_buf_get_option(picker_orig_win_bufnr, "filetype")
 				if buftype == "toggleterm" then
-					util.start_insert_mode()
+					utils.start_insert_mode()
 				end
 			end
 		end,
@@ -38,10 +38,11 @@ M.open = function(opts)
 
 	local picker = pickers.new(opts, {
 		prompt_title = config.titles.prompt,
-		results_title = config.display_mappings and util.format_results_title(config.mappings) or config.titles.results,
+		results_title = config.display_mappings and utils.format_results_title(config.mappings)
+			or config.titles.results,
 		preview_title = config.titles.preview,
 		previewer = conf.grep_previewer(opts),
-		finder = util.create_finder(),
+		finder = utils.create_finder(),
 		sorter = conf.generic_sorter(opts),
 		attach_mappings = function(prompt_bufnr, map)
 			local mappings = config.mappings

lua/util.lua lua/lib/utils/init.lualua/util.lua renamed to lua/lib/utils/init.lua

@@ -12,4 +12,6 @@ M.open = require("lib.telescope").open
 M.setup = function(opts)
 	require("config").setup(opts)
 end
+M.utils = require("lib.utils")
+
 return M