feat!: use kitty_mod for keymaps

BREAKING CHANGE: The default mapping keys changed from `ctrl+shift` to `kitty_mod`. - If you are using the default value for `kitty_mod` of `ctrl+shift`, then no change is needed. - If you are using a different value for `kitty_mod`, then you should correct any potential mapping conflicts that may occur now that `kitty-scrollback.nvim` is using `kitty_mod`. closes #30
mikesmithgh · Nov 1, 2023 · 8e652bf · 8e652bf
1 parent e16e96a
commit 8e652bf
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,11 @@ Navigate your Kitty scrollback buffer to quickly search, copy, and execute comma
     ```
   - Remove previous kitty-scrollback.nvim Kitten mappings in `kitty.conf`
 
+  - The default mapping keys changed from `ctrl+shift` to `kitty_mod`. The default values for `kitty_mod` in Kitty is `ctrl+shift`.
+    - If you are using the default value for `kitty_mod` of `ctrl+shift`, then no change is needed.
+    - If you are using a different value for `kitty_mod`, then you should correct any potential mapping conflicts that may occur
+      now that `kitty-scrollback.nvim` is using `kitty_mod`.
+
   - Migrate any customized configurations to the new format
     - When you define your kitty-scrollback.nvim Kitten configuration, do not use `--config-file` `yourconfigfile.lua`. Instead,
       move the contents of `yourconfigfile.lua` to an entry in the configuration passed to the kitty-scrollback.nvim setup function.
@@ -70,7 +75,7 @@ Navigate your Kitty scrollback buffer to quickly search, copy, and execute comma
 
         ```kitty
             # Browse output of the last shell command in nvim
-            map ctrl+shift+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
+            map kitty_mod+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
         ```
         
         ```lua
@@ -93,7 +98,7 @@ Navigate your Kitty scrollback buffer to quickly search, copy, and execute comma
 
         ```kitty
             # Browse output of the last shell command in nvim
-            map ctrl+shift+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
+            map kitty_mod+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
         ```
         
         ```lua
@@ -293,7 +298,13 @@ nvim +'KittyScrollbackCheckHealth'
 
 </details>
 <details>
-<summary>Test <code>kitty-scrollback.nvim</code> is working as expected by pressing <code>ctrl+shift+h</code> to open the scrollback buffer in Neovim</summary>
+<summary>Test <code>kitty-scrollback.nvim</code> is working as expected by pressing <code>kitty_mod+h</code> to open the scrollback buffer in Neovim</summary>
+
+`kitty_mod` is a special modifier key alias for default shortcuts. You can change the value of this option to 
+alter all default shortcuts that use `kitty_mod`. See Kitty documentation [#opt-kitty.kitty_mod](https://sw.kovidgoyal.net/kitty/conf/#opt-kitty.kitty_mod).
+
+The default value of `kitty_mod` is `ctrl+shift`. In this example, `kitty_mod+h` represents `ctrl+shift+h`.
+
 </details>
 
 <details>
@@ -308,11 +319,11 @@ shell_integration enabled
 action_alias kitty_scrollback_nvim kitten /Users/mike/gitrepos/kitty-scrollback.nvim/python/kitty_scrollback_nvim.py
 
 # Browse scrollback buffer in nvim
-map ctrl+shift+h kitty_scrollback_nvim
+map kitty_mod+h kitty_scrollback_nvim
 # Browse output of the last shell command in nvim
-map ctrl+shift+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
+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
+mouse_map kitty_mod+right press ungrabbed combine : mouse_select_command_output : kitty_scrollback_nvim --config ksb_builtin_last_visited_cmd_output
 ```
 
 </details>

diff --git a/doc/kitty-scrollback.nvim.txt b/doc/kitty-scrollback.nvim.txt
@@ -49,6 +49,11 @@ MIGRATING TO V2.0.0                *kitty-scrollback.nvim-migrating-to-v2.0.0*
         nvim --headless +'KittyScrollbackGenerateKittens' +'set nonumber' +'set norelativenumber' +'%print' +'quit!' 2>&1
     <
 - Remove previous kitty-scrollback.nvim Kitten mappings in `kitty.conf`
+- The default mapping keys changed from `ctrl+shift` to `kitty_mod`. The default
+    values for `kitty_mod` in Kitty is `ctrl+shift`.
+    - If you are using the default value for `kitty_mod` of `ctrl+shift`, then no change is needed.
+    - If you are using a different value for `kitty_mod`, then you should correct any potential mapping conflicts that may occur
+        now that `kitty-scrollback.nvim` is using `kitty_mod`.
 - Migrate any customized configurations to the new format
     - When you define your kitty-scrollback.nvim Kitten configuration, do not use
         `--config-file` `yourconfigfile.lua`. Instead, move the contents of
@@ -72,7 +77,7 @@ MIGRATING TO V2.0.0                *kitty-scrollback.nvim-migrating-to-v2.0.0*
                 The Kitten defined in `kitty.conf` references the configuration file `get_text_last_cmd_output.lua`
             >kitty
                     # Browse output of the last shell command in nvim
-                    map ctrl+shift+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
+                    map kitty_mod+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
             <
             >lua
                     -- get_text_last_cmd_output.lua
@@ -92,7 +97,7 @@ MIGRATING TO V2.0.0                *kitty-scrollback.nvim-migrating-to-v2.0.0*
                 The Kitten defined in `kitty.conf` references the builtin configuration name `ksb_builtin_last_cmd_output`
             >kitty
                     # Browse output of the last shell command in nvim
-                    map ctrl+shift+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
+                    map kitty_mod+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
             <
             >lua
                     require('kitty-scrollback').setup({ 
@@ -255,7 +260,15 @@ The following steps outline how to properly configure kitty.conf
 
 - Follow the instructions of any `ERROR` or `WARNINGS` reported during the healthcheck
 
-- Test kitty-scrollback.nvim is working as expected by pressing ctrl+shift+h to open the scrollback buffer in Neovim
+- Test kitty-scrollback.nvim is working as expected by pressing kitty_mod+h to open the scrollback buffer in Neovim
+
+`kitty_mod` is a special modifier key alias for default shortcuts. You can
+change the value of this option to alter all default shortcuts that use
+`kitty_mod`. See Kitty documentation #opt-kitty.kitty_mod
+<https://sw.kovidgoyal.net/kitty/conf/#opt-kitty.kitty_mod>.
+
+The default value of `kitty_mod` is `ctrl+shift`. In this example,
+`kitty_mod+h` represents `ctrl+shift+h`.
 
 - See example kitty.conf for reference
 
@@ -268,11 +281,11 @@ The following steps outline how to properly configure kitty.conf
     action_alias kitty_scrollback_nvim kitten /Users/mike/gitrepos/kitty-scrollback.nvim/python/kitty_scrollback_nvim.py
 
     # Browse scrollback buffer in nvim
-    map ctrl+shift+h kitty_scrollback_nvim
+    map kitty_mod+h kitty_scrollback_nvim
     # Browse output of the last shell command in nvim
-    map ctrl+shift+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
+    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
+    mouse_map kitty_mod+right press ungrabbed combine : mouse_select_command_output : kitty_scrollback_nvim --config ksb_builtin_last_visited_cmd_output
 <
 
 

diff --git a/lua/kitty-scrollback/api.lua b/lua/kitty-scrollback/api.lua
@@ -94,9 +94,9 @@ M.generate_kittens = function(all, generate_modes)
 
   local builtin_map_configs = {
     '# Browse scrollback buffer in nvim',
-    'map ctrl+shift+h ' .. action_alias,
+    'map kitty_mod+h ' .. action_alias,
     '# Browse output of the last shell command in nvim',
-    'map ctrl+shift+g ' .. action_alias .. ' --config ksb_builtin_last_cmd_output',
+    'map kitty_mod+g ' .. action_alias .. ' --config ksb_builtin_last_cmd_output',
     '# Show clicked command output in nvim',
     'mouse_map ctrl+shift+right press ungrabbed combine : mouse_select_command_output : '
       .. action_alias

diff --git a/scripts/breaking_change_config_file.txt b/scripts/breaking_change_config_file.txt
@@ -36,7 +36,7 @@ The Kitten defined in `kitty.conf` references the configuration file `get_text_l
 
 >kitty
     # Browse output of the last shell command in nvim
-    map ctrl+shift+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
+    map kitty_mod+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
 <
 
 >lua
@@ -60,7 +60,7 @@ The Kitten defined in `kitty.conf` references the builtin configuration name `ks
 
 >kitty
     # Browse output of the last shell command in nvim
-    map ctrl+shift+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
+    map kitty_mod+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
 <
 
 >lua

diff --git a/scripts/mini.sh b/scripts/mini.sh
@@ -62,9 +62,9 @@ printf "\n\t\033[38;2;167;192;128mctrl-c to quit\033[0m\n"
 # run kitty
 kitty --config="${tmp_rtp}/${plug_name}/scripts/kitty.conf" \
 	--override "action_alias=kitty_scrollback_nvim kitten ${tmp_plug_dir}/python/kitty_scrollback_nvim.py --env HOME=${TEMPDIR} --env PACKPATH=${packpath} --nvim-args -u ${tmp_plug_dir}/scripts/init.lua" \
-	--override "map ctrl+shift+h kitty_scrollback_nvim" \
-	--override "map ctrl+shift+g kitty_scrollback_nvim --config last_cmd_output" \
+	--override "map kitty_mod+h kitty_scrollback_nvim" \
+	--override "map kitty_mod+g kitty_scrollback_nvim --config last_cmd_output" \
 	--override "mouse_map ctrl+shift+right press ungrabbed combine : mouse_select_command_output : kitty_scrollback_nvim --config last_visited_cmd_output" \
-	kitten @ launch --cwd="${tmp_dir}" --hold printf "\n\t         \033[0m\033[38;2;167;192;128mkitty-scrollback.nvim\033[0m   \033[38;2;150;140;129mmini.sh                 \033[0m\n\t\033[38;2;150;140;129m🭽▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔🭾\033[0m\033[38;2;150;140;129m\n\t\033[38;2;150;140;129m▏\033[0m\033[38;2;167;192;128mctrl+shift+h\033[0m            \033[38;2;150;140;129mscrollback buffer      ▕\033[0m\n\t\033[38;2;150;140;129m▏\033[0m\033[38;2;167;192;128mctrl+shift+g \033[0m           \033[38;2;150;140;129mlast command ouput     ▕\033[0m\n\t\033[38;2;150;140;129m▏\033[0m\033[38;2;167;192;128mctrl+shift+right-click\033[0m  \033[38;2;150;140;129mselected command output▕\033[0m\n\t\033[38;2;150;140;129m🭼▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁🭿\033[0m\n"
+	kitten @ launch --cwd="${tmp_dir}" --hold printf "\n\t         \033[0m\033[38;2;167;192;128mkitty-scrollback.nvim\033[0m   \033[38;2;150;140;129mmini.sh                 \033[0m\n\t\033[38;2;150;140;129m🭽▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔🭾\033[0m\033[38;2;150;140;129m\n\t\033[38;2;150;140;129m▏\033[0m\033[38;2;167;192;128mkitty_mod+h\033[0m             \033[38;2;150;140;129mscrollback buffer      ▕\033[0m\n\t\033[38;2;150;140;129m▏\033[0m\033[38;2;167;192;128mkitty_mod+g \033[0m            \033[38;2;150;140;129mlast command ouput     ▕\033[0m\n\t\033[38;2;150;140;129m▏\033[0m\033[38;2;167;192;128mctrl+shift+right-click\033[0m  \033[38;2;150;140;129mselected command output▕\033[0m\n\t\033[38;2;150;140;129m🭼▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁🭿\033[0m\n"
 
 printf "\n\tmini.sh was copied and modified from fzf-lua, https://github.com/ibhagwan/fzf-lua\n\t%s \033[0;31m♥\033[0m fzf-lua\n\n" "$plug_name"