feat: Sticky cursor for visual mode(s).

Author: kylechui

lua/nvim-surround/init.lua

@@ -95,6 +95,7 @@ M.visual_surround = function(args)
         return
     end
 
+    local sticky_mark = buffer.set_extmark(args.curpos)
     if vim.fn.visualmode() == "\22" then -- Visual block mode case (add delimiters to every line)
         if vim.o.selection == "exclusive" then
             last_pos[2] = last_pos[2] - 1
@@ -144,13 +145,12 @@ M.visual_surround = function(args)
         buffer.insert_text(first_pos, delimiters[1])
     end
 
-    config.get_opts().indent_lines(first_pos[1], last_pos[1] + #delimiters[1] + #delimiters[2] - 2)
-
-    -- TODO: We should be updating the cursor after every insertion, in case the cursor is sticky.
     buffer.restore_curpos({
         first_pos = first_pos,
+        sticky_pos = buffer.get_extmark(sticky_mark),
         old_pos = args.curpos,
     })
+    config.get_opts().indent_lines(first_pos[1], last_pos[1] + #delimiters[1] + #delimiters[2] - 2)
 end
 
 -- Delete a surrounding delimiter pair, if it exists.

tests/configuration_spec.lua

@@ -1,5 +1,6 @@
 local cr = vim.api.nvim_replace_termcodes("<CR>", true, false, true)
 local esc = vim.api.nvim_replace_termcodes("<Esc>", true, false, true)
+local ctrl_v = vim.api.nvim_replace_termcodes("<C-v>", true, false, true)
 local get_curpos = function()
     local curpos = vim.api.nvim_win_get_cursor(0)
     return { curpos[1], curpos[2] + 1 }
@@ -325,6 +326,86 @@ describe("configuration", function()
         check_curpos({ 1, 2 })
     end)
 
+    it("can make the cursor 'stick' to the text (visual)", function()
+        require("nvim-surround").buffer_setup({
+            move_cursor = "sticky",
+        })
+
+        set_lines({
+            "this is a line",
+        })
+        set_curpos({ 1, 9 })
+        vim.cmd("normal vllS'")
+        check_curpos({ 1, 12 })
+
+        set_lines({
+            "this is a line",
+            "with some more text",
+        })
+        set_curpos({ 1, 6 })
+        vim.cmd("normal vjeSb")
+        check_curpos({ 2, 9 })
+
+        set_lines({
+            "this is a line",
+            "with some more text",
+        })
+        set_curpos({ 1, 6 })
+        vim.cmd("normal vjeoSb")
+        check_curpos({ 1, 7 })
+    end)
+
+    it("can make the cursor 'stick' to the text (visual line)", function()
+        require("nvim-surround").buffer_setup({
+            move_cursor = "sticky",
+        })
+
+        set_lines({
+            "this is a line",
+        })
+        set_curpos({ 1, 9 })
+        vim.cmd("normal VSb")
+        check_curpos({ 2, 9 })
+
+        set_lines({
+            "this is a line",
+            "with some more text",
+        })
+        set_curpos({ 1, 6 })
+        vim.cmd("normal VjStdiv" .. cr)
+        check_curpos({ 3, 6 })
+    end)
+
+    it("can make the cursor 'stick' to the text (visual block)", function()
+        require("nvim-surround").buffer_setup({
+            move_cursor = "sticky",
+            surrounds = {
+                ["x"] = {
+                    add = { { "|", "" }, { "", "|" } },
+                },
+            },
+        })
+
+        set_lines({
+            "this is a line",
+            "this is another line",
+        })
+        set_curpos({ 1, 5 })
+        vim.cmd("normal! " .. ctrl_v .. "jf ")
+        vim.cmd("normal Sb")
+        check_curpos({ 2, 9 })
+
+        set_lines({
+            "this is a line",
+            "this is another line",
+            "some more random text",
+        })
+        set_curpos({ 1, 4 })
+        vim.cmd("normal! " .. ctrl_v .. "jjww")
+        vim.cmd("normal Sx")
+        set_curpos({ 8, 8 })
+    end)
+
     it("can make the cursor 'stick' to the text (delete)", function()
         require("nvim-surround").buffer_setup({
             move_cursor = "sticky",