Why are bindings in mini.files affected by timeoutlen?

[csswright]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.files

Question

Pressing g? did not trigger the help menu nor did my other custom bindings like gy and gY until I realized they needed to be pressed before timeoutlen times out. But there's no mappings bound to g in the mini.files buffer so they should not be affected by timeoutlen, right? If I have general mappings:

vim.keymap.set("n", "gy", function() vim.notify("gy") end)
vim.keymap.set("n", "gY", function() vim.notify("gY") end)

, they are not affected by timeoutlen and the y/Y can be pressed at any time after g is pressed.

I like my timeoutlen at 300 and it's never an issue because it only affects the mappings I intend like gz and gzz. I would like to use gy/gY mappings on mini.file buffer and not have them affected by timeoutlen since there seems to be no reason to.

P.S. Unrelated, but is possible to extend the preview to "the rest of the available space" (width/length-wise)? I tried width_preview = 99999 but it has no effect, so seems like this needs to be calculated dynamically. I prefer previews to take up as much remaining space as possible because partially overlapped content behind it is almost never useful (most if not all of the time only the right portion of lines are shown if the preview window small).

[abeldekat]

Hello @csswright,

Thanks for the questions!

But there's no mappings bound to g in the mini.files buffer...

There is, g? itself

If I have general mappings: ..., ... they are not affected by timeoutlen and the y/Y can be pressed at any time after g is pressed.

I think they are affected by timeoutlen:

vim.pack.add({ 'https://github.com/nvim-mini/mini.nvim' })

require('mini.files').setup()

-- The default timeoutlen is 1000ms
vim.keymap.set('n', 'gy', function() vim.notify('gy') end)
vim.keymap.set('n', 'gY', function() vim.notify('gY') end)

If I run nvim with only the code above, press g, wait for more than a second and press y, nothing happens. EDIT: As expected...

I would like to use gy/gY mappings on mini.file buffer and not have them affected by timeoutlen since there seems to be no reason to.

I don't think this is possible, but I am not sure. @echasnovski?

... possible to extend the preview to "the rest of the available space" ...

You can try this code:

local full_preview = function(args)
  local state = MiniFiles.get_explorer_state()
  if state == nil then return end

  -- Return when event is not for focused window
  local focused_path = state.branch[state.depth_focus]
  local idx_focused
  for i, win in ipairs(state.windows) do
    if win.path == focused_path and win.win_id == args.data.win_id then idx_focused = i end
  end
  if idx_focused == nil then return end

  -- Given focused window, the preview window must be the next
  local preview_idx = idx_focused + 1
  -- Only maximize when preview window is the last window
  if preview_idx ~= #state.windows then return end

  local preview_id = state.windows[preview_idx].win_id
  local preview_config = vim.api.nvim_win_get_config(preview_id)
  preview_config.width = vim.o.columns - (preview_config.col + 2)
  vim.api.nvim_win_set_config(preview_id, preview_config)
end

require('mini.files').setup({ windows = { preview = true } })

local gr = vim.api.nvim_create_augroup('custom-config', {})
local new_autocmd = function(event, pattern, callback, desc)
  local opts = { group = gr, pattern = pattern, callback = callback, desc = desc }
  vim.api.nvim_create_autocmd(event, opts)
end
new_autocmd('User', 'MiniFilesWindowUpdate', full_preview, 'Ensure full preview')

[echasnovski]

I would like to use gy/gY mappings on mini.file buffer and not have them affected by timeoutlen since there seems to be no reason to.

I don't think this is possible, but I am not sure. @echasnovski?

All keys in a more than a single key mapping have to be typed within 'timeoutlen' milliseconds between each other. This is how 'timeoutlen' works.

The one workaround is to use 'mini.clue' which implements its own key query process in which 'timeoutlen' does not matter. For that, explicitly ensuring buffer triggers (with g configured as a trigger) should do the trick.

[echasnovski]

Pressing g? did not trigger the help menu nor did my other custom bindings like gy and gY until I realized they needed to be pressed before timeoutlen times out.

I am not quite sure what that means. Is it "press g and then press ? within 'timeoutlen'" or is it "type g? and then wait for 'timeoutlen'"? The first one is how all mappings in Neovim work and what 'timeoutlen' is for. The second can only happen if there are other mappings that start with g? (like g?? or similar).

Could you please elaborate on this?

[csswright]

Ahh, ok, I used mini.clue with trigger and got mixed up thinking timeoutlen only takes effect when there's ambiguity like if both g and gy are mappings (that seems more powerful). I guess maybe creating custom operator is another workaround to ignoring timeoutlen. I added MiniClue.ensure_buf_triggers(buf_id) to autocmd MiniFilesBufferCreate to use mini.clue in mini.files buffer.

@abeldekat Thanks, seems to work well.