Merge pull request #307 from mrjones2014/mrj/111/zellij

feat(mux): Experimental Zellij support

Author: mrjones2014

README.md

@@ -19,6 +19,7 @@ multiplexer split panes. See [Multiplexer Integrations](#multiplexer-integration
 - [Usage](#usage)
   - [Multiplexer Integrations](#multiplexer-integrations)
     - [Tmux](#tmux)
+    - [Zellij](#zellij)
     - [Wezterm](#wezterm)
     - [Kitty](#kitty)
       - [Credits](#credits)
@@ -389,6 +390,86 @@ window:
   option_as_alt: "Both" # or "OnlyLeft" or "OnlyRight" if you prefer
 ```
 
+#### Zellij
+
+> [!NOTE]
+> Zellij support is currently experimental. Please try it out and report any issues! \
+> Resizing by a specific amount from Neovim and presetting new split size is unsupported.
+
+Add the following keymap config to your Zellij KDL config, adjusting the keys you wish to use as necessary.
+No configuration should be needed on the Neovim side.
+
+```kdl
+keybinds {
+  shared_except "locked" {
+    bind "Ctrl h" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "move_focus_or_tab";
+            payload "left";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+    bind "Ctrl j" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "move_focus";
+            payload "down";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+    bind "Ctrl k" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "move_focus";
+            payload "up";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+    bind "Ctrl l" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "move_focus_or_tab";
+            payload "right";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+    bind "Alt h" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "resize";
+            payload "left";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+    bind "Alt j" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "resize";
+            payload "down";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+    bind "Alt k" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "resize";
+            payload "up";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+    bind "Alt l" {
+        MessagePlugin "https://github.com/hiasr/vim-zellij-navigator/releases/download/0.2.1/vim-zellij-navigator.wasm" {
+            name "resize";
+            payload "right";
+            move_mod "ctrl";
+            resize_mod "alt";
+        };
+    }
+  }
+}
+```
+
 #### Wezterm
 
 > [!NOTE]

lua/smart-splits/config.lua

@@ -113,6 +113,8 @@ function M.set_default_multiplexer()
     config.multiplexer_integration = Multiplexer.tmux
   elseif term == 'wezterm' then
     config.multiplexer_integration = Multiplexer.wezterm
+  elseif vim.env.ZELLIJ ~= nil then
+    config.multiplexer_integration = 'zellij'
   elseif vim.env.KITTY_LISTEN_ON ~= nil then
     -- Kitty doesn't use $TERM_PROGRAM, and also requires remote control enabled anyway
     config.multiplexer_integration = Multiplexer.kitty

lua/smart-splits/mux/zellij.lua

@@ -0,0 +1,91 @@
+local Direction = require('smart-splits.types').Direction
+local log = require('smart-splits.log')
+
+local function zellij_exec(cmd)
+  local command = vim.deepcopy(cmd)
+  table.insert(command, 1, 'zellij')
+  local result = vim.fn.systemlist(command)
+  return result
+end
+
+---@type SmartSplitsMultiplexer
+local M = {} ---@diagnostic disable-line: missing-fields
+
+M.type = 'zellij'
+
+function M.current_pane_id()
+  local output = zellij_exec({ 'action', 'list-clients' })
+  if not output[2] then
+    return nil
+  end
+  local pane_id = string.match(output[2], '%S+%s+%w+_(%d+)')
+  return pane_id
+end
+
+function M.current_pane_at_edge()
+  local pane_id = M.current_pane_id()
+  if pane_id == nil then
+    log.warn('could not get zeillij pane id')
+    return false
+  end
+  zellij_exec({ 'action', 'move-focus', Direction.left })
+  local new_pane_id = M.current_pane_id()
+
+  if new_pane_id == nil then
+    log.warn('could not get zeillij pane id')
+    return false
+  end
+
+  return pane_id == new_pane_id
+end
+
+-- amount is not supported on zellij
+function M.resize_pane(direction, _amount) ---@diagnostic disable-line: unused-local
+  if not M.is_in_session() then
+    return false
+  end
+
+  local ok, _ = pcall(zellij_exec, { 'action', 'resize', 'increase', direction })
+  return ok
+end
+
+function M.is_in_session()
+  return M.current_pane_id() ~= nil
+end
+
+function M.current_pane_is_zoomed()
+  return false
+end
+
+function M.next_pane(direction)
+  if not M.is_in_session() then
+    return false
+  end
+  local ok, _ = pcall(zellij_exec, { 'action', 'move-focus', direction })
+  return ok
+end
+
+-- size is not supported on zellij
+function M.split_pane(direction, _size) ---@diagnostic disable-line: unused-local
+  -- zellij only splits right and down; for the others,
+  -- we must split right and down then swap the panes
+  local args = { 'action', 'new-pane' }
+  local need_swap
+  if direction == Direction.left then
+    table.insert(args, 'right')
+    need_swap = 'right'
+  elseif direction == Direction.up then
+    table.insert(args, 'down')
+    need_swap = 'down'
+  else
+    table.insert(args, direction)
+  end
+  local split_ok, _ = pcall(zellij_exec, args)
+  if need_swap ~= nil then
+    local swap_ok = pcall(zellij_exec, { 'action', 'move-pane', need_swap })
+    return split_ok and swap_ok
+  end
+  return split_ok
+end
+
+return M

lua/smart-splits/types.lua

@@ -16,7 +16,7 @@
 ---
 ---@alias SmartSplitsFloatWinBehavior 'previous'|'mux'
 
----@alias SmartSplitsMultiplexerType 'tmux'|'wezterm'|'kitty'
+---@alias SmartSplitsMultiplexerType 'tmux'|'wezterm'|'kitty'|'zellij'
 
 ---@class SmartSplitsContext
 ---@field mux SmartSplitsMultiplexer|nil Multiplexer API, if one is currently in use
@@ -55,6 +55,8 @@ local M = {
     wezterm = 'wezterm',
     ---@type SmartSplitsMultiplexerType
     kitty = 'kitty',
+    ---@type SmartSplitsMultiplexerType
+    zellij = 'zellij',
   },
 }