feat(scroll): added option for animating scroll only when count is given

Author: declancm

README.md

@@ -73,6 +73,9 @@ return {
         -- `window`: animate window scrolling ONLY when the cursor moves out of view
         mode = "cursor",
 
+        -- Only animate scrolling if a count is provided
+        count_only = false,
+
         -- Delay between each movement step (in ms)
         delay = 5,
 

lua/cinnamon/config.lua

@@ -23,6 +23,7 @@ local defaults = {
             time = 1000, ---@type number
         },
         mode = "cursor", ---@type "cursor" | "window"
+        count_only = false, ---@type boolean
     },
 }
 

lua/cinnamon/init.lua

@@ -74,32 +74,32 @@ M.setup = function(user_config)
         vim.keymap.set({ "n", "x" }, "z-", function() M.scroll("z-") end)
         vim.keymap.set({ "n", "x" }, "z^", function() M.scroll("z^") end)
         vim.keymap.set({ "n", "x" }, "z+", function() M.scroll("z+") end)
-        vim.keymap.set({ "n", "x" }, "<C-y>", function() M.scroll("<C-y>") end)
-        vim.keymap.set({ "n", "x" }, "<C-e>", function() M.scroll("<C-e>") end)
+        vim.keymap.set({ "n", "x" }, "<C-y>", function() M.scroll("<C-y>", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "<C-e>", function() M.scroll("<C-e>", { count_only = true }) end)
 
         -- Horizontal screen scrolling:
-        vim.keymap.set({ "n", "x" }, "zh", function() M.scroll("zh") end)
-        vim.keymap.set({ "n", "x" }, "zl", function() M.scroll("zl") end)
+        vim.keymap.set({ "n", "x" }, "zh", function() M.scroll("zh", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "zl", function() M.scroll("zl", { count_only = true }) end)
         vim.keymap.set({ "n", "x" }, "zH", function() M.scroll("zH") end)
         vim.keymap.set({ "n", "x" }, "zL", function() M.scroll("zL") end)
         vim.keymap.set({ "n", "x" }, "zs", function() M.scroll("zs") end)
         vim.keymap.set({ "n", "x" }, "ze", function() M.scroll("ze") end)
 
         -- Up/down movements:
-        vim.keymap.set({ "n", "x" }, "k", function() M.scroll("k") end)
-        vim.keymap.set({ "n", "x" }, "j", function() M.scroll("j") end)
-        vim.keymap.set({ "n", "x" }, "<Up>", function() M.scroll("<Up>") end)
-        vim.keymap.set({ "n", "x" }, "<Down>", function() M.scroll("<Down>") end)
-        vim.keymap.set({ "n", "x" }, "gk", function() M.scroll("gk") end)
-        vim.keymap.set({ "n", "x" }, "gj", function() M.scroll("gj") end)
-        vim.keymap.set({ "n", "x" }, "g<Up>", function() M.scroll("g<Up>") end)
-        vim.keymap.set({ "n", "x" }, "g<Down>", function() M.scroll("g<Down>") end)
+        vim.keymap.set({ "n", "x" }, "k", function() M.scroll("k", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "j", function() M.scroll("j", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "<Up>", function() M.scroll("<Up>", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "<Down>", function() M.scroll("<Down>", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "gk", function() M.scroll("gk", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "gj", function() M.scroll("gj", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "g<Up>", function() M.scroll("g<Up>", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "g<Down>", function() M.scroll("g<Down>", { count_only = true }) end)
 
         -- Left/right movements:
-        vim.keymap.set({ "n", "x" }, "h", function() M.scroll("h") end)
-        vim.keymap.set({ "n", "x" }, "l", function() M.scroll("l") end)
-        vim.keymap.set({ "n", "x" }, "<Left>", function() M.scroll("<Left>") end)
-        vim.keymap.set({ "n", "x" }, "<Right>", function() M.scroll("<Right>") end)
+        vim.keymap.set({ "n", "x" }, "h", function() M.scroll("h", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "l", function() M.scroll("l", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "<Left>", function() M.scroll("<Left>", { count_only = true }) end)
+        vim.keymap.set({ "n", "x" }, "<Right>", function() M.scroll("<Right>", { count_only = true }) end)
     end
     --stylua: ignore end
 end

lua/cinnamon/scroll.lua

@@ -90,6 +90,7 @@ H.scroller = {
             and not vim.b.cinnamon_disable
             and step_count > 1
             and vim.fn.reg_executing() == "" -- A macro is not being executed
+            and (not self.options.count_only or vim.v.count ~= 0)
             and original_buffer_id == self.buffer_id
             and original_window_id == self.window_id
             and not disabled_filetypes[vim.bo[self.buffer_id].filetype]