feat!: remove support for nvim v0.9 (#334)

BREAKING CHANGE: remove support for Neovim version 0.9

If you are using Neovim version 9.0 and cannot upgrade, then you can still use tag v6.4.0 of kitty-scrolback.nvim

Author: mikesmithgh

.github/workflows/static.yml

@@ -17,7 +17,7 @@ jobs:
         uses: rhysd/action-setup-vim@v1
         with:
           neovim: true
-          version: 'stable'
+          version: 'nightly' # v0.12 needed for uv annotations
 
       - name: Install dependencies
         run: |

.github/workflows/tests.yml

@@ -39,13 +39,11 @@ jobs:
           - 'stable'  # 0.45.+
           - 'nightly'
         # update __branch-protection-rules.json and run __update_branch_protection_rules.sh when modified
-        # test only latest patch versions of nvim released as of v0.9.0
+        # test only latest patch versions of nvim released as of v0.10.4
         # test only latest patch versions of kitty released as of v0.32.2
         include:
           # nvim versions + kitty stable
-          - nvim_version: 'v0.9.0'
-            kitty_version: 'stable'
-          - nvim_version: 'v0.9.5'
+          - nvim_version: 'v0.10.0'
             kitty_version: 'stable'
           - nvim_version: 'v0.10.4'
             kitty_version: 'stable'

.github/workflows/validate-backport.yml

@@ -10,7 +10,7 @@ Navigate your [Kitty](https://sw.kovidgoyal.net/kitty/) scrollback buffer to qui
 
 <!-- panvimdoc-ignore-start -->
 
-[![neovim: v0.9+](https://img.shields.io/static/v1?style=flat-square&label=neovim&message=v0.9%2b&logo=neovim&labelColor=282828&logoColor=8faa80&color=414b32)](https://neovim.io/)
+[![neovim: v0.10+](https://img.shields.io/static/v1?style=flat-square&label=neovim&message=v0.10%2b&logo=neovim&labelColor=282828&logoColor=8faa80&color=414b32)](https://neovim.io/)
 [![kitty v0.32.2+](https://img.shields.io/badge/v0.32.2%2B-352217?style=flat-square&logo=data%3Aimage%2Fjpeg%3Bbase64%2C%2F9j%2F4AAQSkZJRgABAQAAAQABAAD%2F4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb%2F2wBDACodICUgGiolIiUvLSoyP2lEPzo6P4FcYUxpmYagnpaGk5GovfLNqLPltZGT0v%2FV5fr%2F%2F%2F%2F%2Fo8v%2F%2F%2F%2F%2F%2F%2FL%2F%2F%2F%2F%2F2wBDAS0vLz83P3xERHz%2FrpOu%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwAARCAEAAQADASIAAhEBAxEB%2F8QAGgABAAMBAQEAAAAAAAAAAAAAAAECAwQFBv%2FEAC8QAQACAQIEAgkFAQEAAAAAAAABAgMEERIhMVFBYQUTFCIyUnGRoUJTgZLB4SP%2FxAAXAQEBAQEAAAAAAAAAAAAAAAAAAQID%2F8QAGxEBAQEBAQEBAQAAAAAAAAAAAAERAhIhMUH%2F2gAMAwEAAhEDEQA%2FAPHAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHXix1ikTtG8rzWs9ax9mfTXlwjrtgpPht9GVtPaPhnddieaxCYmJ2mNhUAiJmdojdpXBefCI%2BppjMbxpu9vwt7NXvKbF81zDp9mr3lWdN2t%2BDYeawGlsF48In6M5iYnnEwupgBETM7RG4A2rp7T8U7NK4KR4b%2FVNi%2Ba5R2xSsdKx9lcuOs0mdoiYhPS%2BXIA0yAAAAAAAAAA7MU746z5LsNNb3Zr2bud%2FXSfgAiotWLRtaN2UaesTvO8x2bC6YiIiI2iNkggAAAAImImNpjdIDGdPWZ3jeI7Na1isbVjZIumACAplnbHafJdhqbbVivdZ%2BpfxzgOjmAAAAAABtunhnsCBPDPZALY7cF4n7u1wOnT5N68M9Y6M9RrmtgGGwAATFLW%2BGsz9IJiYnaYmPqCAAAAAiJmdoiZnyWml6xvNbR9YBUAAABx5b8eSZ8PBvnvw02jrLlb5jHV%2FgCeGezTKBPDPZG2wAAAJisgg3nutwx3TwwmrisWlaJiUcMI4T4fUzWCsTF4267o3mq1bc%2FMHYKY78Uea7DoPQ02krWItkje3afBzaOkX1Fd%2Bkc3qNcxnqit6VvG16xMeaMlprtELVneIknUtxh5uq03qZ4q86T%2BHO9jNSMmK1Z8YeOlmOnN0b6XTzmtvblSOvmwevgpFMNKx25kmnVxalK442pWIjyWRadqzKuO02336r6kuObDU6St4m2ONrdo6S87o9t5mtpFNRO36o3Oo3zXOCmTJFeUdWWnNliZy23RFY8VrW57zzlTebNua0zEKzaThTwwfD6rvPcX4YRwx3NMVEzWUKgAALRXunesdk1cU3nunilbihpSsTG8gzj3vCUxXhtE7dJbgqs0%2FXjlpS3FXdTaazvX7d167Tzjlv1ZrUdWhtFdRG%2FjGz03iRMxMTHKYepp9RXNXaZ2v4wvNZ6i2X4o%2Bi%2BP4ILVi3VPKI7RDM5s6tZRktFMdrT4Ru8Z16zUxf8A86TvXxnu5F6rfMHsYrRfFW0eMPHdWj1MY%2FcvPuz0nsc06mu7J8CuLrLTlaO8SitYrHJLzb3Kws83X2i2o2j9MbOzUaiuGve3hDy7TNrTaZ3mectdVrmKZL8Fd%2FsypT9eWf4a2iN4tPPbpCm02ne327JGqyvXjvNoidlZ93wl0DWMuXilG89296REbwz4oEUF96yiax4GmKgKgAAtjpxz5Kt8HwT9QXisVjlCQRQAAAF6zunp0YZbzSu8TtLL12T5vwnlr09GuqzVjaMk%2FwA81b5smT47zMdnB67J834PXZPm%2FBlNjsb10ma0b8G31l5sZ8kTvFua%2Ftup%2Fev9zyXp3zpM0fo3%2BksJiYnaY2mHP7bqf3r%2FAHUnPlmZmbzMz4nlJ07qZsmP4LzEdl51Wa0bTkn%2BOTzfXZPm%2FB67J834Mq%2Bo7JmZneecomdnJ67J834a4rzeJ4p3lPJ6XmdwGkABBW1K26wsA5r0mk%2BSrfP8H8sFQAAAAXx34J59JUAdUTExyndLkImYneBddYyrm5e9H2JzRtyj7g0m0R1mIVnLWPHdzzMzO89QNTe03neUAIAAAAAAAAJpaazvCAHRXLWevJaLRPSYlykTMTvAuusZVzRt70fYtm5e7H3BqiZiOs7OWZmZ3nqBq%2BS%2FHPLpCgCAAAAAAAAAAAALY8d8s7Y6WtPlCLVtS01tExMdYl6vobJj4L4%2BUZN9%2FrDp12jrqqbxtGSOk%2F5IPAFslLY7zS8TFo6xKoAAAAAAAAAAAAAAAAAAAAAAAAAAAAJpa1LRaszFo6TD3dBra6mvDfaMsdY7vBTW1qWi1ZmLR0mAe9rtHXVU3jaMkdJ%2FyXhZKWx3ml4mLR1h7eg1tdTXhvtGWOsd1tdo66qm8bRkjpP%2BSDwBOSlsd5peJi0dYQAAAAAAAAAAAAAAAAAAAAAAAAAAAACa2tS0WrMxaOkw93QayNVThtyyVjn5%2BbxcGG%2BoyxTHG8z%2BHv6XTU02Phrzmetu4M9fo66jHNo5ZKxynv5PAex6S10Y4nDine88rT2eOAAAAAAAAAAAAAAAAAAAAAAAAAAA0wYb6jLFMcbzP4MGG%2BoyxTHG8z%2BHv6XTU02Lhpzmetu4Gl01NNj4a85nrbu5fSOv9VE4sM%2B%2F4z8v%2FT0jr%2FVb4sM%2B%2FwCNvl%2F68br1A6zzAAF64ct43pjvaO8VmU%2BzZ%2F2cn9ZBmNfZs%2F7OT%2Bsns2f9nJ%2FWQZDT2bP%2Bzk%2FrKLYctI3vjvWO81mAUAAAAAAAAAAAAAAAAAAAB6vobJirjvWZiMkzvz8YX9IekIxxOLBaJvPW0eDxwDr1AAI68%2BgA%2BmwXx2xVnFMTXblsu%2BWAfVIfLAPqVM18dMVpyzEV257vmQCevIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAH%2F9k%3D&label=kitty&labelColor=282828)](https://sw.kovidgoyal.net/kitty/)
 [![semantic-release: angular](https://img.shields.io/static/v1?style=flat-square&label=semantic-release&message=angular&logo=semantic-release&labelColor=282828&logoColor=d8869b&color=8f3f71)](https://github.com/semantic-release/semantic-release)
 [![test status](https://img.shields.io/github/actions/workflow/status/mikesmithgh/kitty-scrollback.nvim/tests.yml?style=flat-square&logo=github&logoColor=c7c7c7&label=tests&labelColor=282828&event=push)](https://github.com/mikesmithgh/kitty-scrollback.nvim/actions/workflows/tests.yml?query=event%3Apush)
@@ -29,7 +29,7 @@ Navigate your [Kitty](https://sw.kovidgoyal.net/kitty/) scrollback buffer to qui
 ## 📖 Contents
 
 - ✨ [Features](#-features)
-- 🚀 [Migrating to v6.0.0](#-migrating-to-v600)
+- 🚀 [Migrating to v7.0.0](#-migrating-to-v700)
 - 📚 [Prerequisites](#-prerequisites)
 - 🏃 [Quickstart](#-quickstart)
 - 📦 [Installation](#-installation)
@@ -198,17 +198,17 @@ This requires extra steps to setup. See optional [tmux setup](#tmux--experimenta
 
 </details>
 
-## 🚀 Migrating to v6.0.0
+## 🚀 Migrating to v7.0.0
 > [!IMPORTANT]\
-> v6.0.0 has breaking changes.
+> v7.0.0 has breaking changes.
 > 
 > You can ignore this section if you have not previously installed any version of kitty-scrollback.nvim
 
 <details>
 
   <summary>Migration Steps</summary>
 
-  If you have any problems or questions migrating to `v6.0.0`, please open an 
+  If you have any problems or questions migrating to `v7.0.0`, please open an 
   [issue](https://github.com/mikesmithgh/kitty-scrollback.nvim/issues) or
   [discussion](https://github.com/mikesmithgh/kitty-scrollback.nvim/discussions).
 
@@ -218,40 +218,19 @@ This requires extra steps to setup. See optional [tmux setup](#tmux--experimenta
 
   <!-- panvimdoc-ignore-end -->
 
-  - kitty-scrollback.nvim v6.0.0 changes the default keymap for quitting kitty-scrollback.nvim from `<Esc>` to `q`.
-    No steps are necessary if you prefer this new behavior.
+  - kitty-scrollback.nvim v7.0.0 dropped support for Neovim version 0.9.
 
+    If you are using Neovim version 9.0, please upgrade to 10.0 or greater. 
 
-    If you prefer the previous behavior of using `<Esc>` to exit kitty-scrollback.nvim, this can be reconfigured by
-    adding the following to your kitty-scrollback.nvim setup.
+    If you are using Neovim version 9.0 and cannot upgrade, then you can still use tag v6.4.0 of kitty-scrolback.nvim
 
-    ```lua
-    vim.keymap.set({ 'n' }, '<Esc>', '<Plug>(KsbCloseOrQuitAll)', {})
-    ```
-
-    For example, if you are using lazy.nvim, it would look something like this
-
-    ```lua
-    return {
-      {
-        'mikesmithgh/kitty-scrollback.nvim',
-        lazy = true,
-        cmd = { 'KittyScrollbackGenerateKittens', 'KittyScrollbackCheckHealth' },
-        event = { 'User KittyScrollbackLaunch' },
-        config = function()
-          vim.keymap.set({ 'n' }, '<Esc>', '<Plug>(KsbCloseOrQuitAll)', {}) -- quit kitty-scrollback.nvim with Esc key
-          -- vim.keymap.set({ 'n' }, 'q', '<Plug>(KsbCloseOrQuitAll)', {}) -- uncomment if you would like to also quit with the q key
-          require('kitty-scrollback').setup()
-        end,
-      },
-    }
-    ```
+    See https://github.com/mikesmithgh/kitty-scrollback.nvim/releases/tag/v6.4.0
 
 </details>
 
 ## 📚 Prerequisites
 
-- Neovim [v0.9+](https://github.com/neovim/neovim/releases)
+- Neovim [v0.10+](https://github.com/neovim/neovim/releases)
 - Kitty [v0.32.2+](https://github.com/kovidgoyal/kitty/releases)
 
 ## 🏃 Quickstart

README.md

@@ -5,7 +5,7 @@ Table of Contents                    *kitty-scrollback.nvim-table-of-contents*
 
 1. kitty-scrollback.nvim         |kitty-scrollback.nvim-kitty-scrollback.nvim|
   - Features                                  |kitty-scrollback.nvim-features|
-  - Migrating to v6.0.0            |kitty-scrollback.nvim-migrating-to-v6.0.0|
+  - Migrating to v7.0.0            |kitty-scrollback.nvim-migrating-to-v7.0.0|
   - Prerequisites                        |kitty-scrollback.nvim-prerequisites|
   - Quickstart                              |kitty-scrollback.nvim-quickstart|
   - Installation                          |kitty-scrollback.nvim-installation|
@@ -111,50 +111,28 @@ This requires extra steps to setup. See optional
 - That’s it! You are in Neovim, navigate the scrollback buffer.
 
 
-MIGRATING TO V6.0.0                *kitty-scrollback.nvim-migrating-to-v6.0.0*
+MIGRATING TO V7.0.0                *kitty-scrollback.nvim-migrating-to-v7.0.0*
 
 
   |‼| |IMPORTANT|
-  v6.0.0 has breaking changes.
+  v7.0.0 has breaking changes.
   You can ignore this section if you have not previously installed any version of
   kitty-scrollback.nvim
 
 `-` `Migration Steps`
-    If you have any problems or questions migrating to `v6.0.0`, please open an
+    If you have any problems or questions migrating to `v7.0.0`, please open an
     issue <https://github.com/mikesmithgh/kitty-scrollback.nvim/issues> or
     discussion <https://github.com/mikesmithgh/kitty-scrollback.nvim/discussions>.
-    - kitty-scrollback.nvim v6.0.0 changes the default keymap for quitting
-        kitty-scrollback.nvim from `<Esc>` to `q`. No steps are necessary if you prefer
-        this new behavior.
-        If you prefer the previous behavior of using `<Esc>` to exit
-        kitty-scrollback.nvim, this can be reconfigured by adding the following to your
-        kitty-scrollback.nvim setup.
-
->lua
-            vim.keymap.set({ 'n' }, '<Esc>', '<Plug>(KsbCloseOrQuitAll)', {})
-<
-        For example, if you are using lazy.nvim, it would look something like this
-
->lua
-            return {
-              {
-                'mikesmithgh/kitty-scrollback.nvim',
-                lazy = true,
-                cmd = { 'KittyScrollbackGenerateKittens', 'KittyScrollbackCheckHealth' },
-                event = { 'User KittyScrollbackLaunch' },
-                config = function()
-                  vim.keymap.set({ 'n' }, '<Esc>', '<Plug>(KsbCloseOrQuitAll)', {}) -- quit kitty-scrollback.nvim with Esc key
-                  -- vim.keymap.set({ 'n' }, 'q', '<Plug>(KsbCloseOrQuitAll)', {}) -- uncomment if you would like to also quit with the q key
-                  require('kitty-scrollback').setup()
-                end,
-              },
-            }
-<
+    - kitty-scrollback.nvim v7.0.0 dropped support for Neovim version 0.9.
+        If you are using Neovim version 9.0, please upgrade to 10.0 or greater.
+        If you are using Neovim version 9.0 and cannot upgrade, then you can still use
+        tag v6.4.0 of kitty-scrolback.nvim
+        See https://github.com/mikesmithgh/kitty-scrollback.nvim/releases/tag/v6.4.0
 
 
 PREREQUISITES                            *kitty-scrollback.nvim-prerequisites*
 
-- Neovim v0.9+ <https://github.com/neovim/neovim/releases>
+- Neovim v0.10+ <https://github.com/neovim/neovim/releases>
 - Kitty v0.32.2+ <https://github.com/kovidgoyal/kitty/releases>
 
 
@@ -640,6 +618,8 @@ CONFIGURATION OPTIONS
       checkhealth = false,
       -- string? Sets the mode for coloring the Visual highlight group in the scrollback buffer window. darken uses a darkened version of the Normal highlight group to improve readability. kitty uses the colors defined for selection_foreground and selection_background in your Kitty configuration. nvim uses the default colors defined in the Visual highlight group. reverse reverses the foreground and background colors of the visual selection.
       visual_selection_highlight_mode = 'darken',
+      -- integer? Temporary column width during get-text operation to avoid hard wrapping (larger values may impact performance), see :h columns
+      scrollback_columns = 300,
     }
 <
 

doc/kitty-scrollback.nvim.txt

@@ -197,6 +197,7 @@ KsbOpts                                                   *default_opts.KsbOpts*
         {kitty_get_text}                   (KsbKittyGetText|nil)                           options passed to get-text when reading scrollback buffer, see `kitty @ get-text --help`
         {checkhealth}                      (boolean|nil)                                   if true execute :checkhealth kitty-scrollback and skip setup
         {visual_selection_highlight_mode}  (string|"darken"|"kitty"|"nvim"|"reverse"|nil)
+        {scrollback_columns}               (integer|nil)                                   temporary column width during get-text operation to avoid hard wrapping (larger values may impact performance), see :h columns
 
 
 ==============================================================================

doc/kitty-scrollback.nvim_spec.txt

@@ -311,12 +311,7 @@ M.checkhealth = function()
     vim.api.nvim_get_runtime_file('python/kitty_scrollback_nvim.py', false)[1],
     ':p'
   )
-  -- NOTE(#58): nvim v0.9 support
-  -- setup backports for v0.9 because checkhealth can be called outside of standard setup flow
-  if vim.fn.has('nvim-0.10') <= 0 then
-    require('kitty-scrollback.backport').setup()
-  end
-  if vim.fn.has('nvim-0.9') > 0 then
+  if vim.fn.has('nvim-0.10') > 0 then
     vim
       .system({
         -- fallback to 'kitty' because checkhealth can be called outside of standard setup flow
@@ -331,7 +326,7 @@ M.checkhealth = function()
       :wait()
   else
     -- fallback on checkhealth for earlier versions of nvim
-    vim.cmd.checkhealth('kitty-scrollback')
+    vim.cmd('checkhealth kitty-scrollback') -- prefer vim.cmd('checkhealth') over vim.cmd.checkhealth to support older versions of neovim
   end
 end
 

lua/kitty-scrollback/api.lua

@@ -12,6 +12,18 @@ local p
 ---@type KsbOpts
 local opts ---@diagnostic disable-line: unused-local
 
+---Normalize to string[]
+---@param value? string|string[]
+---@return string[]
+local function as_list(value)
+  if type(value) == 'string' then
+    return { value }
+  elseif type(value) == 'table' then
+    return value
+  end
+  return {}
+end
+
 M.setup = function(private, options)
   p = private
   opts = options ---@diagnostic disable-line: unused-local
@@ -127,7 +139,7 @@ M.set_term_enter_autocmd = function(bufid)
 end
 
 M.set_colorscheme_autocmd = function()
-  vim.api.nvim_create_autocmd({ 'Colorscheme' }, {
+  vim.api.nvim_create_autocmd({ 'ColorScheme' }, {
     group = vim.api.nvim_create_augroup('KittyScrollBackNvimColorscheme', { clear = true }),
     callback = ksb_hl.set_highlights,
   })
@@ -195,7 +207,7 @@ M.set_yank_post_autocmd = function()
         end
 
         local contents = {}
-        for _, line in pairs(yankevent.regcontents) do
+        for _, line in ipairs(as_list(yankevent.regcontents)) do
           line = line:gsub('%s+$', '')
           table.insert(contents, line)
         end