Surround jumps to parent surrounds instead of actual surrounding pair if some keybinds are set

mnpqraven commented 1 year ago

Checklist

[X] Have you tried updating the plugin to the latest version?
[X] Have you checked the Breaking Changes issue?
[X] Have you read through :h nvim-surround to see if there might be any relevant information there?

Neovim Version

NVIM v0.8.2
Build type: Release
LuaJIT 2.1.0-beta3

Plugin Version

Tagged (Stable)

Minimal Configuration

vim.g.loaded_netrw = 1
vim.g.loaded_netrwPlugin = 1

vim.opt.termguicolors = true

local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
  vim.fn.system({
    "git",
    "clone",
    "--filter=blob:none",
    "https://github.com/folke/lazy.nvim.git",
    "--branch=stable", -- latest stable release
    lazypath,
  })
end
vim.opt.rtp:prepend(lazypath)

vim.g.mapleader = " "
vim.g.maplocalleader = "\\"

require('lazy').setup({
  { 'kylechui/nvim-surround', tag = '*' },

})

local M = {}

local function bind(op, outer_opts)
    outer_opts = outer_opts or {noremap = true}
    return function (lhs, rhs, opts)
        opts = vim.tbl_extend( "force", outer_opts, opts or {} )
        vim.keymap.set(op, lhs, rhs, opts)
    end
end

M.map      = bind("", {noremap = false})
M.noremap      = bind("", {noremap = true})

M.map('N', 'K')
M.map('n', 'gj')
M.map('E', 'J')
M.map('e', 'l')
M.map('k', 'nzz')
M.map('K', 'Nzz')
M.map('l', 'gk')
M.map('E', '$')
M.map('H', '0')
M.map('N', 'L')

Sample Buffer

impl DatabaseRequirement {
    pub fn generate_resource(&self) -> GrandResource {
        // Vec<UnitRequirement> > GrandResource
        let mut sum = GrandResource::new();
        for unit in &self.unit_req {
            sum.combine(unit.get_req());
            dbg!(&sum);
            // dbg!(sum.combine(unit.get_req()));
        }
        dbg!(&sum);
        sum
    }
}

Keystroke Sequence

cursor inside the for loop, changing the surrounds with cs{ttest<CR>

Expected behavior

only the for loop's brackets get changed

Actual behavior

the for loop's parent (the function brackets) is selected instead if my cursor is at specific position noted below

Additional context

https://user-images.githubusercontent.com/8957788/212528698-74667943-2e3d-4e59-86aa-1c2f892d6ca3.mp4

https://user-images.githubusercontent.com/8957788/212528699-754e48b1-6431-493f-b9af-08fe9b84efcd.mp4

I'm using a colemak keyboard and therefore needed to change some of my basic vim keys to another layout and cause the surround to select the parent surrounds in some cases. I've noticed 2 things when trying to reproduce this bug(?)

So far I was able to narrow down that the surround selection is messed up if I set the above keybinds.
For the multiple lines surround, the surround will incorrectly select if my cursor is at the line directly after the opening parent but before the row of the opening parent. If I copy paste a few lines to said for loop in the code above like so
```
for unit in &self.unit_req {
sum.combine(unit.get_re||q||()); // <- ||cursor||
sum.combine(unit.get_req());
sum.combine(unit.get_req());
}
```
The surround would work correctly if my cursor is on the q in the first get_req() or anywhere on the right side or in the lines below, but the surround would incorrectly select the outer surround (the function parens) if my cursor is anywhere on the left. I hope this makes sense.

mnpqraven commented 1 year ago

Update on the issue: I've found out that the key map that caused the issue was the l key triggering the cursor to move up if I also remap it to all the modes. When I press cs the cursor would somehow move up just move up and the above surround would get selected instead. The problem can be resolved by only mapping the l keys for navigation in strictly normal and insert mode. Not really sure myself how the l key can cause conflicts with the plugin though.

vim.keymap.set({ 'n', 'v' }, 'l', 'gk')