[mini.pick] source.show swallows an error

[drowning-cat]

Contributing guidelines

• I have read CONTRIBUTING.md
• I have read CODE_OF_CONDUCT.md
• I have updated 'mini.nvim' to latest version of the main branch

Module(s)

mini.pick

Neovim version

0.12 (!at least latest Nightly build!)

Description

An error inside the show function silently closes the picker without any visible message. This can be a little bit disorienting, especially in cases where the show function is overridden, since it's not clear what went wrong.

This behavior seems unintended to me, so I'm opening this issue.

Expectation

I would expect the error to be visible in such cases, for example by re-throwing it or using vim.notify.

Reproduction

nvim --noplugin -u repro.lua repro.lua
<Space>f
<Esc>
:messages -- No error

-- repro.lua

vim.pack.add({
  { src = "https://github.com/nvim-mini/mini.nvim" },
})

require("mini.pick").setup()

MiniPick.registry.files = function(local_opts, opts)
  opts = vim.tbl_deep_extend("keep", opts or {}, {
    source = {
      show = function()
        error("No error?")
      end,
    },
  })
  return MiniPick.builtin.files(local_opts, opts)
end

vim.keymap.set("n", "<Space>f", "<Cmd>Pick files<CR>", { desc = "Pick files" })

[echasnovski]

Thanks for the issue!

As far as I remember, this is an expected behavior, unfortunately. And is a result of some technical issues of implementing it otherwise (something to do with how vim.fn.getcharstr() works). But I'll take a closer look later.

[drowning-cat]

I don't fully understand the problem, but the first idea that comes to mind is storing H._error from xpcall and then re-throwing it inside picker_stop, since you have to press a key anyway to close the picker. I also found that api.nvim_echo works, but only without the err flag. So perhaps this should be fixed in Neovim itself (lock state interrupt).

Thank you for taking a look at the problem. Anyway, I'll wait for your decision regarding the issue 🙂