[mini.clue] How to get clues for a key mapped to another key?

[rynoV]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.clue

Question

Hi, thanks for making this!

I've been trying mini.clue after using which-key, and missing one thing: if I have a mapping like

vim.keymap.set('n', '<leader>w', '<C-w>', { desc = '+Window' })

I can't seem to get the miniclue.gen_clues.windows() clues to pop up when I use the <leader>w mapping. It shows <C-w> in my status line, but the clues only show up when I actually hit <C-w>. In which-key I was able to do this using the proxy setting. Is there a way to make this work?

[drowning-cat]

It can be done in user-space configuration, but it is not an ideal solution:

vim.keymap.set("n", "<Leader>w", "<C-w>", { desc = "+Window" })

local windows_clue = function(trigger, opts)
  local clues = MiniClue.gen_clues.windows(opts)
  if trigger then
    for _, clue in ipairs(clues) do
      clue.keys = string.gsub(clue.keys, "^<C%-w>", trigger)
    end
  end
  return clues
end

local MiniClue = require("mini.clue")
MiniClue.setup({
  triggers = {
    { mode = "n", keys = "<C-w>" },
    { mode = "n", keys = "<Leader>w" },
  },
  clues = {
    windows_clue(),
    windows_clue("<Leader>w"),
  },
})

[echasnovski]

Yes, this is an approach I'd go with. Maybe it can be simplified a bit, as there is really no big need in general helper:

vim.keymap.set('n', '<Leader>w', '<C-w>', { desc = '+Window' })

local miniclue = require('mini.clue')

local win_clues = miniclue.gen_clues.windows()
local leader_w_clues = vim.deepcopy(win_clues)
vim.tbl_map(function(c) c.keys = c.keys:gsub('^<C%-w>', '<Leader>w') end, leader_w_clues)

miniclue.setup({
  triggers = {
    { mode = 'n', keys = '<C-w>' },
    { mode = 'n', keys = '<Leader>w' },
  },
  clues = {
    win_clues,
    leader_w_clues,
  },
})

[rynoV]

I switched to use

vim.keymap.set('n', '<leader>w', function()
  vim.api.nvim_input '<C-w>'
end, { desc = '+Window' })

And this seems to work better in that

• The special mini.clues setup isn't required
• With the previous setup above, I realized I couldn't actually use some bindings, for example instead of "Show diagnostics under cursor" for <C-w>d (CTRL-W_d-default), I could only use "Split + jump to definition" with <leader>wd. I don't think this had anything to do with mini.clue

Some caveats though

• mini.clue no longer immediately pops up the <C-w> clues when typing <leader> then waiting then "w". Because it's pressing a whole new key sequence, the mini.clue delay re-applies. Not a big deal for me though
• Not sure how binding under <leader>w would work now, I'd probably just bind under <C-w>