Migrating from v5 to v9

[steakhutzeee]

Hi!

I'm currently running kitty-scrollback with the following config:

local kitty_scrollback_config = function()
  -- https://github.com/mikesmithgh/kitty-scrollback.nvim/issues/152
  vim.keymap.set({ 'v' }, 'Y', '<Plug>(KsbVisualYankLine)', {})
  vim.keymap.set({ 'v' }, 'y', '<Plug>(KsbVisualYank)', {})
  vim.keymap.set({ 'n' }, 'Y', '<Plug>(KsbNormalYankEnd)', {})
  vim.keymap.set({ 'n' }, 'y', '<Plug>(KsbNormalYank)', {})
  vim.keymap.set({ 'n' }, 'yy', '<Plug>(KsbYankLine)', {})
  -- Not using the 'paste window'
  -- vim.keymap.set({ 'v' }, '<leader>Y', '"aY', {})
  -- vim.keymap.set({ 'v' }, '<leader>y', '"ay', {})
  -- vim.keymap.set({ 'n' }, '<leader>Y', '"aY', {})
  -- vim.keymap.set({ 'n' }, '<leader>y', '"ay', {})
  -- vim.keymap.set({ 'n' }, '<leader>yy', '"ayy', {})
  -- return {
  --   paste_window = { yank_register = 'a'},
  -- }
  require('kitty-scrollback').setup({
    {
      visual_selection_highlight_mode = 'kitty',
    },
  })
end

-- https://github.com/mikesmithgh/kitty-scrollback.nvim/issues/270#issuecomment-2452782908
if vim.env.KITTY_SCROLLBACK_NVIM == 'true' then
  -- kitty-scrollback.nvim minimal config
  vim.opt.runtimepath:append(vim.fn.stdpath('data') .. '/lazy/kitty-scrollback.nvim')
  kitty_scrollback_config()
  return {}
else
  return {
    {
      'mikesmithgh/kitty-scrollback.nvim',
      enabled = true,
      lazy = true,
      cmd = { 'KittyScrollbackGenerateKittens', 'KittyScrollbackCheckHealth' },
      event = { 'User KittyScrollbackLaunch' },
      -- version = '*', -- latest stable version, may have breaking changes if major version changed
      version = '^5.0.0', -- pin major version, include fixes and features that do not have breaking changes
      config = kitty_scrollback_config,
    },
  }
end

Am I good to upgrade to version 9 or there is something I should change?

Thank you in advance!

[mikesmithgh]

Hey @steakhutzeee! https://github.com/mikesmithgh/kitty-scrollback.nvim/releases has any break changes documented for major versions.

From v5 -> v9:

• v6: Change the default keymap for quitting kitty-scrollback.nvim from to q
• v7: remove Neovim 0.9 support
• v8: remove Kitty < 0.43.0 support
• v9: remove experimental tmux support

As long as you are on a version of Neovim and Kitty that is supported, you shouldn't see much change, besides that default keymap.

I can't recall why it was needed for that runtimepath:append in your config. I wonder if this would work for you?

return {
  {
    'mikesmithgh/kitty-scrollback.nvim',
    enabled = true,
    lazy = true,
    cmd = { 'KittyScrollbackGenerateKittens', 'KittyScrollbackCheckHealth', 'KittyScrollbackGenerateCommandLineEditing' },
    event = { 'User KittyScrollbackLaunch' },
    -- version = '*', -- latest stable version, may have breaking changes if major version changed
    version = '^5.0.0', -- pin major version, include fixes and features that do not have breaking changes
    config = function()
      if vim.env.KITTY_SCROLLBACK_NVIM == 'true' then
        vim.keymap.set({ 'v' }, 'Y', '<Plug>(KsbVisualYankLine)', {})
        vim.keymap.set({ 'v' }, 'y', '<Plug>(KsbVisualYank)', {})
        vim.keymap.set({ 'n' }, 'Y', '<Plug>(KsbNormalYankEnd)', {})
        vim.keymap.set({ 'n' }, 'y', '<Plug>(KsbNormalYank)', {})
        vim.keymap.set({ 'n' }, 'yy', '<Plug>(KsbYankLine)', {})
      end
      require('kitty-scrollback').setup({
        {
          visual_selection_highlight_mode = 'kitty',
        },
      })
    end,
  },
}

I think I need to figure out a better way for those keymap overrides in the future 😅 . Let me know if you have any issues.

[steakhutzeee]

I think that runtimepath:append comes from the issue in comment on that block #270 (comment)

I remember I had some trouble in configuring it with a minimal nvim configuration and a session plugin.

Also, do I need KittyScrollbackGenerateCommandLineEditing ? It’s not totally clear what it does.

I have this in my kitty.conf:

# Required by kitty-scrollback
allow_remote_control socket-only
listen_on unix:/tmp/kitty

# kitty-scrollback.nvim Kitten alias
action_alias kitty_scrollback_nvim kitten $HOME/.local/share/nvim/lazy/kitty-scrollback.nvim/python/kitty_scrollback_nvim.py --nvim-args -u $HOME/.config/nvim/lua/plugins/kitty-scrollback.lua

# Browse scrollback buffer in nvim
map kitty_mod+f kitty_scrollback_nvim
# Browse output of the last shell command in nvim
map kitty_mod+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
# Show clicked command output in nvim
mouse_map ctrl+shift+right press ungrabbed combine : mouse_select_command_output : kitty_scrollback_nvim --config ksb_builtin_last_visited_cmd_output

[mikesmithgh]

I remember I had some trouble in configuring it with a minimal nvim configuration and a session plugin.

ah that makes sense, since it is a separate config it may not have it on the runtime path

Also, do I need KittyScrollbackGenerateCommandLineEditing ? It’s not totally clear what it does.

That is optional. It is for if you have command-line editing setup https://github.com/mikesmithgh/kitty-scrollback.nvim?tab=readme-ov-file#command-line-editing. KittyScrollbackGenerateCommandLineEditing was introduced at some point after you did you setup. If you want to have kitty-scrollback.nvim act as your editor when you invoke command line editing (like C-xC-e in bash will open your current commandline in your editor defined in $VISUAL or $EDITOR). Those values in cmd are just to support lazy loading, so if you run any of those commands lazy.nvim will automatically load kitty-scrollback.nvim. So, it is solely for lazy loading.

[mikesmithfbg]

is yt$ valid? I tried it in Neovim and doesn't seem to work for me. It works for me if I use other characters, like if I want up to m, ytm.

I use Y a lot to just copy from current position to end of line which is maybe what you want.

But, in general, any yanks should work since kitty-scrollback.nvim is leveraging the TextYankPost autocmd.

[steakhutzeee]

My mistake, I will try with the correct command y$.

[steakhutzeee]

y$ works indeed :)

[mikesmithgh]

Awesome! FYI Y is the same as y$ in Neovim if you want to shave off a character 🙂

[steakhutzeee]

Yep! It was just me trying an invalid command for nvim.