feat: nvchad statusline integration

README.md

@@ -174,6 +174,72 @@ With this plugin you can:
 
 To learn more about SSH configs and how to write/style one you can read more [here](https://linuxize.com/post/using-the-ssh-config-file/)
 
+## 🧩 Status-line integrations
+
+`remote-sshfs.nvim` ships a tiny helper module that exposes the current
+connection (if any) as a **single, reusable component** – so every status-line
+framework can opt-in without additional boiler-plate.
+
+The module returns an **empty string** when no host is mounted which makes it
+safe to drop into existing layouts.
+
+<details>
+<summary><b>NvChad (built-in statusline)</b></summary>
+
+NvChad exposes its UI configuration through the return table of
+`lua/chadrc.lua`.  The snippet below shows a minimal way to **add one custom
+module** (named `remote`) without touching the rest of the default layout.
+
+```lua
+-- ~/.config/nvim/lua/chadrc.lua
+
+local M = {}
+
+-- 1️⃣  Create a callable module for NvChad’s statusline
+local remote_module = require("remote-sshfs.statusline").nvchad_module {
+  highlight = "St_gitIcons", -- highlight group (optional)
+}
+
+--  Option A: use an *existing* highlight group by name (as above).
+--  Option B: provide a colour table and the plugin will create a group for you:
+-- local remote_module = require("remote-sshfs.statusline").nvchad_module {
+--   highlight = { fg = "#6A9955", bold = true },
+-- }
+
+-- 2️⃣  Add it to `modules` *and* reference it in `order`
+M.ui = {
+  statusline = {
+    -- theme / separator_style as you already have…
+
+    -- insert the module name wherever you like
+    order = { "mode", "file", "git", "%=", "lsp_msg", "%=", "diagnostics", "remote", "lsp", "cwd", "cursor" },
+
+    modules = {
+      remote = remote_module,
+    },
+  },
+}
+
+return M
+```
+
+Custom icon:
+
+```lua
+-- has to be set *before* `require("remote-sshfs")` is executed
+vim.g.remote_sshfs_status_icon = ""  -- VS Code-style lock icon
+```
+
+When `RemoteSSHFSConnect` succeeds your status-line reads e.g.
+
+```
+󰀻 myserver
+```
+
+and vanishes as soon as you disconnect.
+
+</details>
+
 ## 🤝 Contributing
 
 If you find a bug or have a suggestion for how to improve remote-sshfs.nvim or additional functionality, please feel free to submit an issue or a pull request. We welcome contributions from the community and are committed to making remote-sshfs.nvim as useful as possible for everyone who uses it.
@@ -182,8 +248,8 @@ If you find a bug or have a suggestion for how to improve remote-sshfs.nvim or a
 
 This repository provides two test suites:
 
-* **Unit tests** – pure-Lua logic, run via [Busted](https://olivinelabs.com/busted/)
-* **Integration tests** – Neovim + [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) harness
+- **Unit tests** – pure-Lua logic, run via [Busted](https://olivinelabs.com/busted/)
+- **Integration tests** – Neovim + [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) harness
 
 ### Unit tests
 

lua/remote-sshfs/statusline.lua

@@ -0,0 +1,133 @@
+local M = {}
+
+-- Default icon displayed when a connection is active. Nerd-font compatible.
+-- Users can override this by setting `vim.g.remote_sshfs_status_icon` before
+-- the plugin is loaded or by changing `M.icon` afterwards.
+M.icon = vim.g.remote_sshfs_status_icon or "󰀻" -- nf-mdi-server
+
+-- Return a short human-readable string that represents the current connection
+-- state. If no connection is active an empty string is returned so that the
+-- statusline stays unchanged.
+--
+-- Examples:
+--   ""                    – when not connected
+--   "󰀻 myserver"          – when connected to host *myserver*
+function M.status()
+  local ok, conn = pcall(require, "remote-sshfs.connections")
+  if not ok or type(conn) ~= "table" then
+    return ""
+  end
+
+  if not conn.is_connected or not conn.is_connected() then
+    return ""
+  end
+
+  local host_tbl = conn.get_current_host and conn.get_current_host() or nil
+  local name = "remote"
+  if host_tbl and type(host_tbl) == "table" then
+    -- Prefer the explicit entries we create while parsing the ssh-config.
+    name = host_tbl.Name or host_tbl.Host or host_tbl.host or name
+  end
+
+  return string.format("%s %s", M.icon, name)
+end
+
+-------------------------------------------------------------------------------
+-- READY-MADE COMPONENTS -------------------------------------------------------
+-------------------------------------------------------------------------------
+
+-- NvChad (Heirline) component factory.
+--
+-- Usage inside `custom/chadrc.lua` (NvChad > v2.*):
+--
+--   local remote = require("remote-sshfs.statusline").nvchad_component()
+--   table.insert(M.active_components, remote) -- wherever you like
+--
+-- The returned table follows Heirline's component specification used by
+-- NvChad, i.e. `provider`, `condition` and `hl` keys.
+--
+-- `opts` (all optional):
+--   highlight (table)  – Highlight table passed as-is to Heirline.
+function M.nvchad_component(opts)
+  opts = opts or {}
+
+  -- Lazily require within the closures because the statusline component is
+  -- evaluated *after* the plugin init code has run.
+  return {
+    condition = function()
+      local ok, conn = pcall(require, "remote-sshfs.connections")
+      return ok and conn.is_connected and conn.is_connected()
+    end,
+    provider = function()
+      return M.status()
+    end,
+    hl = opts.highlight or { fg = "green" },
+  }
+end
+
+-------------------------------------------------------------------------------
+-- NvChad (classic v3 statusline) module helper --------------------------------
+-------------------------------------------------------------------------------
+
+-- NvChad’s in-house statusline (documented under `:h nvui.statusline`) expects
+-- plain strings or Lua callables in the `modules` table.  This helper returns
+-- such a callable, so users can simply do
+--
+--   M.ui = {
+--     statusline = {
+--       modules = {
+--         remote = require("remote-sshfs.statusline").nvchad_module(),
+--       }
+--     }
+--   }
+--
+-- `opts.highlight` – optional highlight group name, e.g. "St_gitIcons".
+function M.nvchad_module(opts)
+  opts = opts or {}
+
+  -- Determine highlight behaviour.
+  -- 1) string  → assume existing highlight group name
+  -- 2) table   → dynamically create a group once and use it
+  -- 3) nil     → no colour decorations
+  local hl_begin, hl_end = "", ""
+
+  if opts.highlight then
+    local group_name
+
+    if type(opts.highlight) == "string" then
+      group_name = opts.highlight
+    elseif type(opts.highlight) == "table" then
+      group_name = "RemoteSSHFSStl"
+      -- Only define once per session.
+      if vim.fn.hlexists(group_name) == 0 then
+        vim.api.nvim_set_hl(0, group_name, opts.highlight)
+      end
+    end
+
+    if group_name then
+      hl_begin = "%#" .. group_name .. "#"
+      hl_end = "%*"
+    end
+  end
+
+  return function()
+    local s = M.status()
+    if s == "" then
+      return ""
+    end
+    return hl_begin .. s .. hl_end
+  end
+end
+
+-------------------------------------------------------------------------------
+-- Fall-back plain string for easy integration in classic statuslines ---------
+-------------------------------------------------------------------------------
+
+-- For simple `statusline` settings ("set statusline=%!v:lua..."), return a Lua
+-- callable that expands to the status string. Example:
+--   vim.o.statusline = "%!v:lua.require('remote-sshfs.statusline').status()"
+function M.vim_statusline()
+  return M.status()
+end
+
+return M