bug: Freeze / Infinite Recursion when trying to show keymaps

[yavorski]

Did you check docs and existing issues?

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

Neovim version (nvim -v)

0.10

Operating system/version

Arch Linux

Describe the bug

Neovim freezes when trying to show s keymaps. I am trying to show mini.surround keymaps, as discussed in several other issues.

Steps To Reproduce

Please see minimal repro.lua and just press s key in normal mode.
I run it with nvim -u repro.lua

Expected Behavior

To not freeze, expand and show keymaps.

Health

which-key: require("which-key.health").check()

- OK Most of these checks are for informational purposes only.
  WARNINGS should be treated as a warning, and don't necessarily indicate a problem with your config.
  Please |DON't| report these warnings as an issue.

Checking your config ~
- WARNING |mini.icons| is not installed
- WARNING |nvim-web-devicons| is not installed
- WARNING Keymap icon support will be limited.

Checking for issues with your mappings ~
- OK No issues reported

checking for overlapping keymaps ~
- WARNING In mode `n`, <gc> overlaps with <gcc>:
  - <gc>: Toggle comment
  - <gcc>: Toggle comment line
- OK Overlapping keymaps are only reported for informational purposes.
  This doesn't necessarily mean there is a problem with your config.

Checking for duplicate mappings ~
- OK No duplicate mappings found

Log

Log too long ... trimmed it to 512k -> https://pastebin.com/raw/LQJR2SWz

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/which-key.nvim",
      event = "VeryLazy",
      config = function()
        local wk = require("which-key")
        wk.setup({ debug = true })
        vim.keymap.set({ "n", "x" }, "s", "<Nop>")
        vim.keymap.set("n", "s", function() wk.show({ keys = "s", mode = "n" }) end, { desc = "Show s keymaps" })
      end
    }
  }
})

[folke]

I mean, what do you expect?
You're literally mapping s and ask which-key to show the results for s

[folke]

You can achieve what you want by adding waited = vim.o.timeoutlen to the show options

[folke]

ok, I'll change it so that this is always set when using the API...

[yavorski]

I mean, what do you expect? You're literally mapping s and ask which-key to show the results for s

Yeah that sounds about right.

You can achieve what you want by adding waited = vim.o.timeoutlen to the show options

This works yes, Thank you!

[folke]

I updated the defaults for the API, so should work without explicitely setting that option