refactor: rename 'auto_run' action from 'files' to 'find' and refactor 'on_mount' hooks

The 'on_mount' hook 'auto_run' option 'files' has been renamed to 'find' for better clarity and consistency.
Introduced 'normalize_action' helper to standardize 'auto_run' values, handling aliases and defaulting to 'find' for unrecognized values.
Refactored 'Hooks.on_mount' to improve readability and maintainability by using helper functions 'normalize_action' and 'find_connection_by_mount'.

Author: uhs-robert

README.md

@@ -31,7 +31,7 @@ Auto-detects your tools: **snacks**, **telescope**, **fzf-lua**, **mini**, **oil
 
 - **Zero dependencies** - Works with your existing file pickers and search tools, no forced plugins
 - **Auto-detection** - Launches telescope, oil, snacks, fzf-lua, mini, yazi, neo-tree, nvim-tree, ranger, lf, nnn, or netrw
-- **On-mount hooks** - Run your own function or built-ins (files, grep, live find/grep) right after a mount
+- **On-mount hooks** - Run your own function or built-ins (find, grep, live find/grep) right after a mount
 - **Live remote search** - Stream `rg`/`find` over SSH with snacks, fzf-lua, telescope, or mini (no local mount thrashing)
 - **Flexible workflow** - Explore files, change directories (`tcd`), run custom commands, or open SSH terminals
 - **Universal auth** - Handles SSH keys, 2FA, passwords, passphrases, host verification via floating terminal
@@ -157,7 +157,7 @@ require("sshfs").setup({
     },
     on_mount = {
       auto_change_to_dir = false, -- auto-change current directory to mount point
-      auto_run = "files",         -- "files" (default), "grep", "live_find", "live_grep", "terminal", "none", or a custom function(ctx)
+      auto_run = "find",          -- "find" (default), "grep", "live_find", "live_grep", "terminal", "none", or a custom function(ctx)
     },
   },
   ui = {

lua/sshfs/config.lua

@@ -39,14 +39,14 @@ local DEFAULT_CONFIG = {
 		on_mount = {
 			auto_change_to_dir = false,       -- auto-change current directory to mount point
 			-- Action to run after a successful mount
-			-- "files" (default): open file picker
+			-- "find" (default): open file picker
 			-- "grep": open grep picker
 			-- "live_find": run remote find over SSH and stream results
 			-- "live_grep": run remote rg/grep over SSH and stream results
 			-- "terminal": open SSH terminal to the mounted host
 			-- "none" or nil: do nothing
 			-- function(ctx): custom handler with { mount_path, host, remote_path }
-			auto_run = "files",
+			auto_run = "find",
 		},
 		on_exit = {
 			auto_unmount = true,              -- auto-disconnect all mounts on :q or exit

lua/sshfs/ui/hooks.lua

@@ -2,86 +2,128 @@
 
 local Hooks = {}
 
---- Run post-mount action (tcd + optional hook)
---- @param mount_dir string Mount directory path
---- @param host string Host name
---- @param remote_path string|nil Remote path used for the mount
---- @param config table Plugin configuration
-function Hooks.on_mount(mount_dir, host, remote_path, config)
-	local hook_cfg = (config.hooks and config.hooks.on_mount) or {}
-	local auto_change_to_dir = hook_cfg.auto_change_to_dir
-	local action = hook_cfg.auto_run
-
-	-- Auto-change directory to mount point if configured
-	if auto_change_to_dir then
-		vim.cmd("tcd " .. vim.fn.fnameescape(mount_dir))
-	end
-
+-- Normalize hook config value into either a callable or a known preset string.
+--- @param action string|function|nil
+--- @return string|function|nil normalized
+local function normalize_action(action)
 	if action == nil or action == "none" then
-		return
+		return nil
 	end
 
-	-- Allow custom handler
 	if type(action) == "function" then
-		local ok, err = pcall(action, {
-			mount_path = mount_dir,
-			host = host,
-			remote_path = remote_path,
-		})
-		if not ok then
-			vim.notify("on_mount callback failed: " .. err, vim.log.levels.ERROR)
-		end
-		return
+		return action
 	end
 
-	-- Normalize preset names
 	local preset = string.lower(action)
-	if preset == "livefiles" then
+	if preset == "livefind" or preset == "live-find" then
 		preset = "live_find"
-	elseif preset == "livegrep" then
+	elseif preset == "livegrep" or preset == "live-grep" then
 		preset = "live_grep"
-	elseif preset == "files" or preset == "live_find" or preset == "live_grep" or preset == "grep" or preset == "terminal" then
-		-- keep as is
-	else
-		preset = "files"
 	end
 
-	-- Resolve connection info for live_* actions
-	local function get_connection()
-		local Connections = require("sshfs.lib.connections")
-		for _, conn in ipairs(Connections.get_all()) do
-			if conn.mount_path == mount_dir then
-				return conn
-			end
+	local allowed = {
+		find = true,
+		live_find = true,
+		live_grep = true,
+		grep = true,
+		terminal = true,
+	}
+
+	if not allowed[preset] then
+		preset = "find"
+	end
+
+	return preset
+end
+
+-- Fetch the connection associated with a mount directory.
+--- @param mount_dir string
+--- @return table|nil connection
+local function find_connection_by_mount(mount_dir)
+	local Connections = require("sshfs.lib.connections")
+	for _, conn in ipairs(Connections.get_all()) do
+		if conn.mount_path == mount_dir then
+			return conn
 		end
-		return nil
 	end
+	return nil
+end
 
-	if preset == "files" then
+-- Execute one of the built-in preset actions.
+--- @param preset string
+--- @param mount_dir string
+--- @param config table
+--- @return nil
+local function run_preset_action(preset, mount_dir, config)
+	if preset == "find" then
 		local Picker = require("sshfs.ui.picker")
-		local success, picker_name = Picker.open_file_picker(mount_dir, config, false)
-		if not success then
+		local ok, picker_name = Picker.open_file_picker(mount_dir, config, false)
+		if not ok then
 			vim.notify("Failed to open " .. picker_name .. " for new mount: " .. mount_dir, vim.log.levels.ERROR)
 		end
-	elseif preset == "grep" then
+		return
+	end
+
+	if preset == "grep" then
 		local Picker = require("sshfs.ui.picker")
 		Picker.grep_remote_files(nil, { dir = mount_dir })
-	elseif preset == "live_grep" or preset == "live_find" then
-		local conn = get_connection()
+		return
+	end
+
+	if preset == "live_grep" or preset == "live_find" then
+		local conn = find_connection_by_mount(mount_dir)
 		if not conn then
 			vim.notify("No connection found for on_mount action: " .. mount_dir, vim.log.levels.WARN)
 			return
 		end
 		local Picker = require("sshfs.ui.picker")
 		local fn = preset == "live_grep" and Picker.open_live_remote_grep or Picker.open_live_remote_find
-		local success, picker_name = fn(conn.host, conn.mount_path, conn.remote_path or ".", config)
-		if not success then
+		local ok, picker_name = fn(conn.host, conn.mount_path, conn.remote_path or ".", config)
+		if not ok then
 			vim.notify("Live action failed: " .. picker_name, vim.log.levels.ERROR)
 		end
-	elseif preset == "terminal" then
+		return
+	end
+
+	if preset == "terminal" then
 		local Terminal = require("sshfs.ui.terminal")
 		Terminal.open_ssh()
 	end
 end
 
+--- Run post-mount action (tcd + optional hook)
+--- @param mount_dir string Mount directory path
+--- @param host string Host name
+--- @param remote_path string|nil Remote path used for the mount
+--- @param config table Plugin configuration
+function Hooks.on_mount(mount_dir, host, remote_path, config)
+	local hook_cfg = (config.hooks and config.hooks.on_mount) or {}
+	local auto_change_to_dir = hook_cfg.auto_change_to_dir
+	local action = normalize_action(hook_cfg.auto_run)
+
+	-- Auto-change directory to mount point if configured
+	if auto_change_to_dir then
+		vim.cmd("tcd " .. vim.fn.fnameescape(mount_dir))
+	end
+
+	if action == nil then
+		return
+	end
+
+	-- Allow custom handler
+	if type(action) == "function" then
+		local ok, err = pcall(action, {
+			mount_path = mount_dir,
+			host = host,
+			remote_path = remote_path,
+		})
+		if not ok then
+			vim.notify("on_mount callback failed: " .. err, vim.log.levels.ERROR)
+		end
+		return
+	end
+
+	run_preset_action(action, mount_dir, config)
+end
+
 return Hooks