feat!: remove experimental support for tmux

closes #115

BREAKING CHANGE: remove experimental support for tmux

Author: mikesmithgh

.github/workflows/tests.yml

@@ -77,7 +77,7 @@ jobs:
       if: ${{ !(inputs.enable_debug_tmate || inputs.enable_debug_vnc) || (inputs.debug_kitty_version == matrix.kitty_version && inputs.debug_nvim_version == matrix.nvim_version) }}
       run: |
         sudo apt update
-        sudo apt install -y xfce4 libxcb-xkb1 xsel tmux fish zsh
+        sudo apt install -y xfce4 libxcb-xkb1 xsel fish zsh
         # homebrew is not used but is required to reproduce an issue for a test case
         /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
 

README.md

@@ -54,7 +54,6 @@ Navigate your [Kitty](https://sw.kovidgoyal.net/kitty/) scrollback buffer to qui
 - ⌨️ [Keymaps](#%EF%B8%8F-keymaps)
 - 🪛 [Optional Setup](#-optional-setup)
   - [Command-line editing](#command-line-editing)
-  - [tmux (🧪 experimental )](#tmux--experimental-)
 - 👏 [Recommendations](#-recommendations)
 - 🤝 [Acknowledgements](#-acknowledgements)
 - 🐶 [Alternatives](#-alternatives)
@@ -189,15 +188,6 @@ This requires extra steps to setup. See optional [Command-line editing setup](#c
 
 </details>
 <details> 
-<summary>😾 tmux support (🧪 experimental )</summary>
-  
-<!-- TODO: add demo -->
-This requires extra steps to setup. See optional [tmux setup](#tmux--experimental-).
-
-- Open a tmux pane's scrollback history (default mapping `<C-b>[`)
-- That's it! You are in Neovim, navigate the scrollback buffer.
-
-</details>
 
 ## 🚀 Migrating to v8.0.0
 > [!IMPORTANT]\
@@ -1052,42 +1042,6 @@ bindkey '^x^e' kitty_scrollback_edit_command_line
 
 </details>
 
-### tmux (🧪 experimental )
-
-> [!WARNING]\
-> 🧪 tmux support is currently experimental
-> If you have questions or encounter any issues using tmux, please comment on [#115](https://github.com/mikesmithgh/kitty-scrollback.nvim/issues/115)
-
-Setup instructions to integrate kitty-scrollback.nvim with [tmux](https://github.com/tmux/tmux). These steps are optional and only
-necessary if you wish to add tmux support to kitty-scrollback.nvim.
-
-- Generate the tmux kitty-scrollback.nvim mappings and add them to `$HOME/.tmux.conf` or `$XDG_CONFIG_HOME/tmux/tmux.conf`
-
-```sh
-nvim --headless +'KittyScrollbackGenerateKittens tmux'
-```
-
-- You may need to source your tmux configuration for these changes to be reflected in a current tmux session.
-
-```sh
-tmux source $HOME/.tmux.conf 
-# or 
-tmux source $XDG_CONFIG_HOME/tmux/tmux.conf
-```
-
-- By default, kitty-scrollback.nvim overrides the default key binding `[` for opening `copy-mode`. If you use the default prefix key `<C-b>` and the
-default key binding `[`, then test opening a tmux's pane scrollback history with kitty-scrollback.nvim by pressing `<C-b>[`. 
-  - You can still access Kitty's scrollback history (default mapping `<C-S-h>`) in a tmux session. However, this is scoped to Kitty and it will only
-  show the current screen. When you open the tmux pane's scrollback history (default mapping `<C-b>[`), this is scoped to tmux and will display all
-  of the scrollback history for that tmux session.
-
-- See example .tmux.conf for reference.
-
-```tmux
-# Browse tmux pane in nvim
-bind [ run-shell 'kitty @ kitten /path/to/your/kitty-scrollback.nvim/python/kitty_scrollback_nvim.py --env "TMUX=$TMUX" --env "TMUX_PANE=#{pane_id}"'
-```
-
 ## 👏 Recommendations
 
 - Check out my ⚡️ Lightning Talk @ Neovim Conf 2023 [Developing kitty-scrollback.nvim](https://youtu.be/9TINe0J9rNg?si=_ISKqAQVS2NCuSRF)!

lua/kitty-scrollback/api.lua

@@ -123,14 +123,6 @@ M.generate_kittens = function(generate_modes)
   end, builtin_map_configs)
   table.insert(builtin_command_configs, '')
 
-  local builtin_tmux_configs = {
-    '# Browse tmux pane in nvim',
-    [[bind [ run-shell 'kitty @ kitten ]]
-      .. kitty_scrollback_kitten
-      .. [[ --env "TMUX=$TMUX" --env "TMUX_PANE=#{pane_id}"']],
-    '',
-  }
-
   local configs = {}
   local filetype
   if target_gen_modes['maps'] then
@@ -143,10 +135,6 @@ M.generate_kittens = function(generate_modes)
     vim.list_extend(configs, builtin_command_configs)
     filetype = 'sh'
   end
-  if target_gen_modes['tmux'] then
-    vim.list_extend(configs, builtin_tmux_configs)
-    filetype = 'tmux'
-  end
   if #vim.tbl_values(target_gen_modes) > 1 then
     filetype = nil
   end

lua/kitty-scrollback/init.lua

@@ -20,7 +20,7 @@ M.setup = function(configs)
   end, {
     nargs = '*',
     complete = function()
-      return { 'maps', 'commands', 'tmux' }
+      return { 'maps', 'commands' }
     end,
   })
 

lua/kitty-scrollback/kitty_commands.lua

@@ -1,5 +1,4 @@
 ---@mod kitty-scrollback.kitty_commands
-local ksb_tmux = require('kitty-scrollback.tmux_commands')
 local ksb_util = require('kitty-scrollback.util')
 local M = {}
 
@@ -44,11 +43,6 @@ local function get_scrollback_cmd(get_text_args)
     .. ' && '
     .. start_set_title_cmd
 
-  if p.kitty_data.tmux and next(p.kitty_data.tmux) then
-    scrollback_cmd = ksb_tmux.get_scrollback_cmd(get_text_args)
-    full_cmd = scrollback_cmd .. ' | ' .. sed_cmd .. ' && ' .. start_set_title_cmd
-  end
-
   return scrollback_cmd, full_cmd
 end
 

lua/kitty-scrollback/launch.lua

@@ -12,8 +12,6 @@ local ksb_api
 local ksb_keymaps
 ---@module 'kitty-scrollback.kitty_commands'
 local ksb_kitty_cmds
----@module 'kitty-scrollback.tmux_commands'
-local ksb_tmux_cmds
 ---@module 'kitty-scrollback.util'
 local ksb_util
 ---@module 'kitty-scrollback.autocommands'
@@ -34,12 +32,6 @@ local M = {}
 ---@field allow_remote_control string 'password' | 'socket-only' | 'socket' | 'no' | 'n' | 'false' | 'yes' | 'y' | 'true'
 ---@field listen_on string
 
----@class KsbTmuxData
----@field socket_path string server socket path
----@field pid string server PID
----@field session_id string unique session ID
----@field pane_id string unique pane ID
-
 ---@class KsbKittyData
 ---@field scrolled_by integer the number of lines currently scrolled in kitty
 ---@field cursor_x integer position of the cusor in the column in kitty
@@ -54,7 +46,6 @@ local M = {}
 ---@field kitty_config_dir string kitty configuration directory path
 ---@field kitty_version table kitty version
 ---@field kitty_path string kitty executable path
----@field tmux KsbTmuxData|nil tmux data
 ---@field shell string kitty shell program to execute
 
 ---@class KsbPrivate
@@ -157,12 +148,6 @@ local set_cursor_position = vim.schedule_wrap(function(d)
   local y = d.cursor_y - 1 - tab_offset
   local scrolled_by = d.scrolled_by
   local lines = d.lines - tab_offset
-  if p.kitty_data.tmux and next(p.kitty_data.tmux) then
-    local ok, status_option = ksb_tmux_cmds.show_status_option()
-    if ok then
-      lines = lines - status_option
-    end
-  end
   if y < 0 then
     -- adjust when on first line of terminal
     lines = lines + math.abs(y)
@@ -217,7 +202,6 @@ local function load_requires()
   ksb_api = require('kitty-scrollback.api')
   ksb_keymaps = require('kitty-scrollback.keymaps')
   ksb_kitty_cmds = require('kitty-scrollback.kitty_commands')
-  ksb_tmux_cmds = require('kitty-scrollback.tmux_commands')
   ksb_util = require('kitty-scrollback.util')
   ksb_autocmds = require('kitty-scrollback.autocommands')
   ksb_health = require('kitty-scrollback.health')
@@ -298,7 +282,6 @@ M.setup = function(kitty_data_str)
 
   ksb_util.setup(p, opts)
   ksb_kitty_cmds.setup(p, opts)
-  ksb_tmux_cmds.setup(p, opts)
   ksb_win.setup(p, opts)
   ksb_footer_win.setup(p, opts)
   ksb_autocmds.setup(p, opts)
@@ -327,15 +310,12 @@ end
 
 ---@class KsbKittyGetTextArguments
 ---@field kitty string kitty args for get-text
----@field tmux string tmux args for capture-pane
 
 ---@return KsbKittyGetTextArguments
 local function get_text_opts()
   local ansi = '--ansi'
-  local tmux_ansi = '-e'
   if not opts.kitty_get_text.ansi then
     ansi = ''
-    tmux_ansi = ''
   end
 
   local clear_selection = '--clear-selection'
@@ -344,23 +324,17 @@ local function get_text_opts()
   end
 
   local extent = '--extent=all'
-  local tmux_extent = '-S - -E -'
   local extent_opt = opts.kitty_get_text.extent
   if extent_opt then
     extent = '--extent=' .. extent_opt
-    if extent_opt == 'screen' then
-      tmux_extent = '-S 0 -E -'
-    end
   end
 
   -- always add wrap markers, wrap markers are important to add blank lines with /r to
   -- fill the screen when setting the cursor position
   local add_wrap_markers = '--add-wrap-markers'
-  local tmux_add_wrap_markers = '-J'
 
   return {
     kitty = ansi .. ' ' .. clear_selection .. ' ' .. add_wrap_markers .. ' ' .. extent,
-    tmux = tmux_ansi .. ' ' .. tmux_add_wrap_markers .. ' ' .. tmux_extent,
   }
 end
 

lua/kitty-scrollback/tmux_commands.lua

@@ -59,31 +59,8 @@ def main():
     raise SystemExit('Must be run as kitten kitty_scrollback_nvim')
 
 
-def parse_tmux_env(env):
-    tmux_data = {}
-    tmux = None
-    tmux_pane = None
-    for e in env:
-        env_kv = e.split('=')
-        if len(env_kv) == 2:
-            key = env_kv[0]
-            value = env_kv[1]
-            if key == 'TMUX':
-                tmux = value
-            if key == 'TMUX_PANE':
-                tmux_pane = value
-    if tmux:
-        tmux_parts = tmux.split(',')
-        if len(tmux_parts) == 3 and tmux_pane:
-            tmux_data['socket_path'] = tmux_parts[0]
-            tmux_data['pid'] = tmux_parts[1]
-            tmux_data['session_id'] = tmux_parts[2]
-            tmux_data['pane_id'] = tmux_pane
-    return tmux_data
-
-
 # based on kitty source window.py
-def pipe_data(w, target_window_id, config, kitty_path, tmux_data):
+def pipe_data(w, target_window_id, config, kitty_path):
     kitty_opts = get_options()
     kitty_shell_integration = get_effective_ksi_env_var(kitty_opts)
     return {
@@ -116,7 +93,6 @@ def pipe_data(w, target_window_id, config, kitty_path, tmux_data):
         },
         'kitty_config_dir': config_dir,
         'kitty_version': version,
-        'tmux': tmux_data,
         'shell': resolved_shell(kitty_opts)[0]
     }
 
@@ -180,12 +156,10 @@ def handle_result(args: List[str],
         config = parse_config(args)
         cwd = parse_cwd(args, w.child.foreground_cwd)
         env = parse_env(args)
-        tmux_data = parse_tmux_env(env)
         kitty_data_str = pipe_data(w,
                                    target_window_id,
                                    config,
-                                   kitty_path,
-                                   tmux_data)
+                                   kitty_path)
         kitty_data = json.dumps(kitty_data_str)
 
         if w.title.startswith('kitty-scrollback.nvim'):