fix: Bounds check when restoring cursor position. (kylechui#365)

* fix: bounds check when restoring cursor position (kylechui#364) * test: Add regression test for invalid cursor position. --------- Co-authored-by: Kyle Chui <[email protected]>
phgz · Jan 31, 2025 · 74f1367 · 74f1367
1 parent 374468b
commit 74f1367
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/lua/nvim-surround/buffer.lua b/lua/nvim-surround/buffer.lua
@@ -25,7 +25,10 @@ M.set_curpos = function(pos)
     if not pos then
         return
     end
-    vim.api.nvim_win_set_cursor(0, { pos[1], pos[2] - 1 })
+
+    local lnum = math.min(pos[1], vim.api.nvim_buf_line_count(0))
+    local column = pos[2] - 1
+    vim.api.nvim_win_set_cursor(0, { lnum, column })
 end
 
 -- Move the cursor to a location in the buffer, depending on the `move_cursor` setting.

diff --git a/tests/configuration_spec.lua b/tests/configuration_spec.lua
@@ -571,4 +571,25 @@ describe("configuration", function()
         assert.are.same(get_curpos(), { 1, 5 })
         check_lines({ "(some 'text')" })
     end)
+
+    it("will clamp cursor position if deleting a surround invalidates the old position", function()
+        require("nvim-surround").setup({
+            move_cursor = false,
+            surrounds = {
+                ["c"] = {
+                    add = function()
+                        return { { "```", "" }, { "", "```" } }
+                    end,
+                    find = "(```[a-zA-Z]*\n)().-(\n```)()",
+                    delete = "(```[a-zA-Z]*\n)().-(\n```)()",
+                },
+            },
+        })
+
+        set_lines({ "```lua", "print('foo')", "```" })
+        set_curpos({ 3, 1 }) -- If we delete the ```, the cursor position won't be valid
+        vim.cmd("normal dsc")
+        assert.are.same(get_curpos(), { 1, 1 })
+        check_lines({ "print('foo')" })
+    end)
 end)