Document the code

Author: jkeresman01

lua/tmux-switch/commands.lua

@@ -2,6 +2,14 @@ local tmux = require("tmux-switch.tmux")
 
 local M = {}
 
+-- Registers custom user commands for tmux operations
+--
+-- This function creates three custom commands in Neovim:
+-- - `TmuxSwitch`: Opens the tmux session switcher.
+-- - `TmuxCreateSession`: Creates a new tmux session with a specified name.
+-- - `TmuxRenameSession`: Renames the current tmux session.
+--
+-- @return nil
 function M.register()
     vim.api.nvim_create_user_command("TmuxSwitch", function()
         tmux.switch()

lua/tmux-switch/tmux.lua

@@ -3,18 +3,36 @@ local util = require("tmux-switch.util")
 
 local M = {}
 
+-- Switches to a different tmux session
+--
+-- This function retrieves the available tmux sessions and displays a picker
+-- for the user to select a session to switch to.
+--
+-- @return nil
 function M.switch()
     local tmux_sessions = util.get_tmux_sessions()
     ui.show_tmux_session_picker(tmux_sessions)
 end
 
+-- Creates a new tmux session
+--
+-- This function prompts the user to input a session name, creates a new tmux
+-- session with the given name, and switches to it.
+--
+-- @return nil
 function M.create_session()
     ui.create_input_prompt("[ TMUX switch ]", "", function(session_name)
         util.create_new_session(session_name)
         util.switch_to_session(session_name)
     end)
 end
 
+-- Renames the current tmux session
+--
+-- This function prompts the user to rename the current tmux session. The prompt
+-- is pre-filled with the current session name for easy editing.
+--
+-- @return nil
 function M.rename_session()
     local current_session = util.get_current_tmux_session()
     ui.create_input_prompt("[ TMUX switch ]", current_session, function(new_session_name)

lua/tmux-switch/ui.lua

@@ -1,17 +1,10 @@
-local util = require("tmux-switch.util")
-
-local actions = require("telescope.actions")
-local action_state = require("telescope.actions.state")
-local finders = require("telescope.finders")
-local pickers = require("telescope.pickers")
-local sorters = require("telescope.sorters")
-local themes = require("telescope.themes")
-
-local nui_input = require("nui.input")
-local event = require("nui.utils.autocmd").event
-
-local M = {}
-
+--- Creates an input prompt with customizable text and a default value
+--
+-- @param prompt_text The text to display at the top of the input prompt
+-- @param default_value The default value for the input (optional)
+-- @param on_submit The function to call when the user submits the input
+--
+-- @return nil
 function M.create_input_prompt(prompt_text, default_value, on_submit)
     local input = nui_input({
         position = "50%",
@@ -45,6 +38,11 @@ function M.create_input_prompt(prompt_text, default_value, on_submit)
     end)
 end
 
+--- Displays a tmux session picker using Telescope
+--
+-- @param tmux_sessions A list of tmux sessions to display in the picker
+--
+-- @return nil
 function M.show_tmux_session_picker(tmux_sessions)
     local opts = themes.get_dropdown({
         layout_config = { width = 50 },

lua/tmux-switch/util.lua

@@ -1,5 +1,11 @@
 local M = {}
 
+-- Retrieves the list of available tmux sessions
+--
+-- This function runs a system command to list all tmux sessions and returns them
+-- as a table of session names.
+--
+-- @return A table containing the names of tmux sessions, or an empty table if an error occurs
 function M.get_tmux_sessions()
     local list_tmux_sessions_cmd = "tmux ls | awk -F ':' '{print $1}'"
     local handle = io.popen(list_tmux_sessions_cmd)
@@ -20,20 +26,39 @@ function M.get_tmux_sessions()
     return tmux_sessions
 end
 
+-- Switches to the specified tmux session
+--
+-- This function switches to the tmux session specified by the session name.
+--
+-- @param session_name The name of the tmux session to switch to
+--
+-- @return nil
 function M.switch_to_session(session_name)
     if session_name then
         local switch_to_session_cmd = string.format("tmux switch -t %s", session_name)
         vim.fn.system(switch_to_session_cmd)
     end
 end
 
+-- Creates a new tmux session
+--
+-- This function creates a new tmux session with the specified session name.
+--
+-- @param session_name The name of the new tmux session to create
+--
+-- @return nil
 function M.create_new_session(session_name)
     if session_name and session_name ~= "" then
         local create_new_session_cmd = string.format("tmux new-session -d -s %s", session_name)
         vim.fn.system(create_new_session_cmd)
     end
 end
 
+-- Retrieves the name of the current tmux session
+--
+-- This function runs a system command to get the name of the current tmux session.
+--
+-- @return The name of the current tmux session, or `nil` if an error occurs
 function M.get_current_tmux_session()
     local display_current_tmux_session_cmd = "tmux display-message -p '#S'"
     local handle = io.popen(display_current_tmux_session_cmd)
@@ -49,6 +74,13 @@ function M.get_current_tmux_session()
     return result:match("^%s*(.-)%s*$")
 end
 
+-- Renames the current tmux session
+--
+-- This function renames the current tmux session to the new specified name.
+--
+-- @param new_session_name The new name for the current tmux session
+--
+-- @return nil
 function M.rename_current_session(new_session_name)
     local rename_current_session_cmd = string.format("tmux rename-session %s", new_session_name)
     vim.fn.system(rename_current_session_cmd)