bug: Overwriting default mappings win.input.keys doesn't work correctly

[dpetka2001]

Did you check docs and existing issues?

• I have read all the snacks.nvim docs
• I have updated the plugin to the latest version before submitting this issue
• I have searched the existing issues of snacks.nvim
• I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

NVIM v0.11.0-dev-1569+g92d3bf101d

Operating system/version

Linux Mint 21.3

Describe the bug

I'm trying to create a custom picker using the following

function M.snacks_picker()
  return {
    layout = {
      preview = false,
    },
    win = {
      input = {
        keys = {
          ["<c-s>"] = { "live_grep", mode = { "i", "n" } },
          ["<M-r>"] = { "oldfiles", mode = { "i", "n" } },
        },
      },
    },
    finder = function()
      local items = {
        {
          _select_key = "/home/your_username/.config/nvim",
          idx = 1,
          score = 1000,
          text = "/home/your_username/.config/nvim",
        },
      }
      return items
    end,
    format = "text",
    actions = {
      confirm = function(picker, item)
        picker:close()
        Snacks.picker.files({ cwd = item.file })
      end,
      live_grep = function(picker, item)
        picker:close()
        Snacks.picker.pick("grep", { cwd = item.file })
      end,
      oldfiles = function(_, item)
        Snacks.picker.recent({ cwd = item.file })
      end,
    },
  }
end

and calling this with `:lua Snacks.picker(Util.snacks.snacks_picker()). Replace this with wherever you save the code snippet above.

When using the custom picker for the first time it works as expected when I press <c-s> and launches the grep picker and the help menu shows

But afterwards, when I launch the custom picker for the second time, pressing <c-s> doesn't do anything and the help menu shows this

It looks like the win.input.keys are getting merged awkwardly? Because it shows the rhs of my custom mapping as the lhs for the default mapping. I also tried <c-g> and it behaves the same. However, I tried <CR> and that behaves correctly. No idea why.

If I did something wrong in the way I tried to implement this, feel free to close this and give me a hint as to how I should do it correctly.

Also if I try to launch the grep picker from the confirm action it works correctly, because it's bound to <CR> by default. But if I use another keymap for the confirm action like <c-g> I observe the same behavior.

PS: I also want to note that I also tried setting the mapping as <C-s> (capital c for the Control modifier) and in that case the mapping is not always taking effect. Sometimes it's taking effect and works as expected even when I invoke my custom picker for a second time and other times the default mapping takes effect. I have to restart Neovim inbetween until my personal mapping takes effect. I believe in this case they get parsed as 2 different mappings (<c-s> is the default one) and somewhere along the way they get converted to the same mapping and it depends on which got parsed later that will overwrite the previous one. That is just my guess anyway.

Steps To Reproduce

1. Save the above code snippet somewhere.
2. Invoke the custom picker with :lua Snacks.picker(custom_module_where_you_saved())
3. Press <c-s> and see the grep picker launch correctly
4. Use the same command from step 2 to invoke the custom picker again
5. Press <c-s> and see nothing happens. Press ? from normal mode in the custom picker to show the help menu and notice that the mapping is weird now.

Expected Behavior

Should be able to overwrite default mappings in my custom picker without problems.

Repro

vim.env.LAZY_STDPATH = ".repro"
load(vim.fn.system("curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua"))()

require("lazy.minit").repro({
  spec = {
    { "folke/snacks.nvim", opts = {} },
    -- add any other plugins here
  },
})

[folke]

Thank you for the detailed bug report. Looking into it right now.

[folke]

Should be fixed now.
I had to re-implement vim.tbl_deep_extend (already had the code for lazy.nvim)

[folke]

Btw, you don't need to close the previous picker when launching a new one.
That prevents flickering:

Snacks.picker({
  layout = {
    preview = false,
  },
  win = {
    input = {
      keys = {
        ["<C-s>"] = { "live_grep", mode = { "i", "n" } },
        ["<M-r>"] = { "oldfiles", mode = { "i", "n" } },
      },
    },
  },
  finder = function()
    local items = {
      {
        _select_key = "/home/your_username/.config/nvim",
        idx = 1,
        score = 1000,
        text = "/home/your_username/.config/nvim",
      },
    }
    return items
  end,
  format = "text",
  actions = {
    confirm = function(picker, item)
      Snacks.picker.files({ cwd = item.file })
    end,
    live_grep = function(picker, item)
      Snacks.picker.pick("grep", { cwd = item.file })
    end,
    oldfiles = function(_, item)
      Snacks.picker.recent({ cwd = item.file })
    end,
  },
})

[dpetka2001]

I just pulled to test this out and am getting an error because of the following

    opts = {
      picker = {
        config = function(opts, _)
          vim.list_extend(opts.sources.lsp_symbols.filter.lua, { "Object" })
        end,
      },
    }

"Error executing lua /home/jrn23/.config/LazyVimDev/lua/plugins/snacks.lua:9: attempt to index field 'filter' (a nil value)". Is the merging in the config function for a snacks broken because of this?

[folke]

That isn't set anywhere in lazyvim? So that could not have worked before either.

[folke]

You're confusing the defaults in the snacks plugin vs options set by lazyvim.
lazy.nvim only sees and can merge/extend options set by lazyvim.
It doesn't know about the defaults inside the snacks plugin.

[dpetka2001]

I'm talking about this.

If you want to customize options for a plugin after they have been resolved, you can use the config function:

{
  gitbrowse = {
    config = function(opts, defaults)
      table.insert(opts.remote_patterns, { "my", "custom pattern" })
    end
  },
}

[folke]

Right. That seems to work for me. What is the rest of your config?

Also what does a dd or similar show of the opts when config is ran?

[dpetka2001]

I did this as per your comment here and it did work until prior to the commit about vim.tbl_deep_extend.

{
    "folke/snacks.nvim",
    dev = true,
    ---@type snacks.plugins.Config
    opts = {
      picker = {
        config = function(opts, _)
          vim.list_extend(opts.sources.lsp_symbols.filter.lua, { "Object" })
        end,
        formatters = {
          file = {
            filename_first = true,
          },
        },
        sources = {
          lsp_symbols = {
            layout = {
              preview = "main",
              preset = "ivy",
            },
          },
        },
      },
      input = {},
      scope = {
        keys = {
          textobject = {
            aL = {
              min_size = 1, -- allow single line scopes
              linewise = true,
              edge = true, -- include the edge
              treesitter = { enabled = false },
              desc = "linewise scope with edge",
            },
            iL = {
              min_size = 1, -- allow single line scopes
              linewise = true,
              edge = false, -- include the edge
              treesitter = { enabled = false },
              desc = "linewise scope with edge",
            },
          },
        },
      },
      scroll = {
        animate = {
          duration = { step = 20, total = 250 },
          easing = "inQuad",
        },
      },
      indent = {
        -- indent = {
        --   only_scope = true,
        -- },
        -- chunk = {
        --   enabled = true,
        -- },
        scope = {
          -- underline = true,
          -- treesitter = {
          --   enabled = false,
          -- },
        },
      },
      styles = {
        input = {
          keys = {
            i_ctrl_c = { "<C-c>", "stopinsert", mode = "i" },
          },
        },
        lazygit = {
          height = 0,
          width = 0,
        },
        notification = {
          wo = { winblend = 0 },
        },
        notification_history = {
          width = 0.8,
          height = 0.8,
          wo = {
            statuscolumn = "",
            signcolumn = "no",
            numberwidth = 3,
          },
        },
        terminal = {
          keys = {
            term_normal = {
              "<esc><esc>",
              function()
                return "<C-\\><C-n>"
              end,
              mode = "t",
              expr = true,
              desc = "Double escape to normal mode",
            },
          },
        },
      },
      notifier = {
        margin = {
          top = 1,
        },
      },
      lazygit = {
        config = {
          os = {
            edit = '[ -z "$NVIM" ] && (nvim -- {{filename}}) || (nvim --server "$NVIM" --remote-send "q" && nvim --server "$NVIM" --remote {{filename}})',
          },
        },
      },
      dashboard = {
        sections = {
          {
            section = "terminal",
            cmd = "figlet -f ~/.config/LazyVimDev/ansi_shadow.flf -ct 'LAZYVIM' | lolcat -F 0.3 -t -p 100 -f",
            -- cmd = "cat ~/.config/LazyVimDev/header.txt",
            height = 6,
            padding = 1,
            -- random = 10,
          },
          { icon = " ", title = "Keymaps", section = "keys", indent = 2, padding = 1 },
          { icon = " ", title = "Recent Files", section = "recent_files", indent = 2, padding = 1, width = 60 },
          { icon = " ", title = "Projects", section = "projects", indent = 2, padding = 1 },
          { section = "startup" },
        },
      },
      scratch = {
        win_by_ft = {
          lua = {
            keys = {
              ["clear"] = {
                "<M-x>",
                function(self)
                  vim.api.nvim_buf_set_lines(self.buf, 0, -1, false, { "" })
                end,
                desc = "Empty buffer",
              },
            },
          },
        },
      },
    },
    keys = {
      {
        "<leader>dpf",
        function()
          Snacks.profiler.pick({ filter = { def_plugin = vim.fn.input("Filter by plugin: ") } })
        end,
        desc = "Profiler Filter by Plugin",
      },
      {
        "<leader>S",
        function()
          Snacks.picker.pick(Util.snacks.scratch_picker())
        end,
        desc = "Select Scratch Buffer",
      },
    },
  },

[dpetka2001]

I put dd(opts) in this gist here so as to not further pollute the issue with large pastes.

So how was it appended to the list if it can't index filter which says is a nil value?

[dpetka2001]

But I can see in the gist with dd(opts) that "Object" was added to lsp_symbols.filter.lua, so I don't really get why that error shows. If I comment out the whole config then lsp_symbols.filter.lua don't contain "Object".

[folke]

Can you check again?

[dpetka2001]

Just pulled and can confirm no error with the config.

[dpetka2001]

Also thank you a lot for your fix about this issue. Can also confirm about no more problems with the keybindings in custom picker. And thanks for your advice about not needing to close the picker. That's how I initially had it as well when I was using a different keybinding. But when I tried to overwrite the defaults and saw this weird behavior, I thought maybe it could be because the picker wasn't correctly closed, so I wanted to be as pedantic as I could with giving reproduction steps in this issue.

[pkazmier]

Btw, you don't need to close the previous picker when launching a new one. That prevents flickering:

We were looking at this example of yours 😄

snacks.nvim/lua/snacks/picker/config/sources.lua

Lines 427 to 437 in 71f69e5

	-- List all available sources
	M.pickers = {
	finder = "meta_pickers",
	format = "text",
	confirm = function(picker, item)
	picker:close()
	if item then
	Snacks.picker(item.text)
	end
	end,
	}