docs: add type docs to entry function

Author: ryanmsnyder

lua/lib/actions/init.lua

@@ -1,8 +1,3 @@
-local has_telescope = pcall(require, "telescope")
-if not has_telescope then
-	vim.notify("Telescope is not installed", vim.log.levels.ERROR)
-	return M
-end
 local actions = require("telescope.actions")
 local actions_state = require("telescope.actions.state")
 local toggleterm_ui = require("toggleterm.ui")
@@ -206,7 +201,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.
 --- @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/lib/telescope/init.lua

@@ -1,18 +1,49 @@
-local pickers, telescope_actions, conf
-if pcall(require, "telescope") then
-	pickers = require("telescope.pickers")
-	telescope_actions = require("telescope.actions")
-	conf = require("telescope.config").values
-else
-	error("Cannot find telescope!")
-end
-local status_ok, _ = pcall(require, "toggleterm")
-if not status_ok then
-	error("Cannot find toggleterm!")
-end
+local pickers = require("telescope.pickers")
+local telescope_actions = require("telescope.actions")
+local conf = require("telescope.config").values
 local util = require("util")
 
+--- 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
+--- to manually exit telescope but still automatically enter insert mode in the terminal buffer
+--- @param picker table The telescope picker object.
+local function telescope_leave_autocmd(picker)
+	vim.api.nvim_create_augroup("InsertOnPickerLeave", {})
+	vim.api.nvim_create_autocmd("BufLeave", {
+		buffer = picker.prompt_bufnr,
+		group = "InsertOnPickerLeave",
+		nested = true,
+		once = true,
+		callback = function()
+			local desktopPath = os.getenv("HOME") .. "/Desktop/new.txt"
+			local file, err = io.open(desktopPath, "a")
+			if not file then
+				print("Error opening file:", err)
+				return
+			end
+			file:write("leave" .. "\n")
+
+			local win_is_valid = vim.api.nvim_win_is_valid(picker.original_win_id)
+			file:write("picker.original_win_id: " .. picker.original_win_id .. "\n")
+			if win_is_valid then
+				file:write("win_is_valid" .. "\n")
+				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")
+				file:write("buftype: " .. buftype .. "\n")
+				if buftype == "toggleterm" then
+					util.start_insert_mode()
+				end
+			end
+			file:write("\n")
+			file:close()
+		end,
+	})
+end
+
 local M = {}
+
+--- Entry point. Opens a telescope picker.
+--- @param opts table The options for the picker.
 M.open = function(opts)
 	local config = require("config").options
 	-- set origin window, which will need to be retrieved in some actions (actions/init.lua)
@@ -43,39 +74,6 @@ M.open = function(opts)
 		end,
 	})
 	picker:find()
-
-	-- 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
-	-- to manually exit telescope but still automatically enter insert mode in the terminal buffer
-	vim.api.nvim_create_augroup("InsertOnPickerLeave", {})
-	vim.api.nvim_create_autocmd("BufLeave", {
-		buffer = picker.prompt_bufnr,
-		group = "InsertOnPickerLeave",
-		nested = true,
-		once = true,
-		callback = function()
-			local desktopPath = os.getenv("HOME") .. "/Desktop/new.txt"
-			local file, err = io.open(desktopPath, "a")
-			if not file then
-				print("Error opening file:", err)
-				return
-			end
-			file:write("leave" .. "\n")
-
-			local win_is_valid = vim.api.nvim_win_is_valid(picker.original_win_id)
-			file:write("picker.original_win_id: " .. picker.original_win_id .. "\n")
-			if win_is_valid then
-				file:write("win_is_valid" .. "\n")
-				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")
-				file:write("buftype: " .. buftype .. "\n")
-				if buftype == "toggleterm" then
-					util.start_insert_mode()
-				end
-			end
-			file:write("\n")
-			file:close()
-		end,
-	})
+	telescope_leave_autocmd(picker)
 end
 return M

lua/telescope-toggleterm.lua

@@ -1,3 +1,9 @@
+local has_telescope = pcall(require, "telescope")
+if not has_telescope then
+	vim.notify("Telescope is not installed", vim.log.levels.ERROR)
+	return
+end
+
 local M = {}
 require("telescope").load_extension("toggleterm")