proper way to set group label names for which-key only for norg files

[osamuaoki]

Currently, norg doesn't set group label names so I see many "+prefix" displayed for non-final key steps in multi-key sequences.

I can't figure out how to bind group label names display just for norg file buffers.

Let me explain with an example. The following discussion example uses the setting:

config = {
      default_keybinds = true,
      neorg_leader = "<leader>n",
 },

Typing <leader> displays:

Then typing n displays:

I know I can add proper group label names by tweaking which-key. But this get activated even for non-norg files.

return {
  -- which-key
  {
    "folke/which-key.nvim",
    opts = {
      -- plugins = { spelling = true },
      defaults = {
        ["<leader>n"] = { name = "+norg" },
        ["<leader>ni"] = { name = "+insert" },
        ["<leader>nl"] = { name = "+list" },
        ["<leader>nm"] = { name = "+mode" },
        ["<leader>nn"] = { name = "+note" },
        ["<leader>nt"] = { name = "+task" },
      },
    },
  },
}

Slightly better (but hackish fix can be done in keybinds.lua of norg:

---@class core.keybinds
module.config.public = {
    keybind_presets = {
        neorg = function(keybinds)
            local leader = keybinds.leader

            -- Map all the below keybinds only when the "norg" mode is active
            -- I want to display "+neorg" in correct position as group label which are grouped after normal bind descriptions
            require("which-key").register({
                  [ leader ] = { name = "+neorg"},
                  [ leader .. "i" ] = { name = "+insert" },
                  [ leader .. "l" ] = { name = "+list" },
                  [ leader .. "m" ] = { name = "+mode" },
                  [ leader .. "n" ] = { name = "+note" },
                  [ leader .. "t" ] = { name = "+task" },
                  })
            keybinds.map_event_to_mode("norg", {
                n = {
                   ......

Then typing <leader> displays

Then typing n displays:

This looks better but not really better than whick-key configuration above when multiple norg and no-neorg files are edited

I think keybinds.map_event_to_mode("norg", ... like assignment is needed for group label name too. That part of code looked a bit too complicated for me to hack.

Anyone have thoughts?

(I don't think #381 nor #679 address issues discussed here.)

[max397574]

when you do that thing inside the neorg config that does absolutely nothing
the only thing it does it that the mappings aren't registered until you start neorg the first time
then they'll also be in non-norg buffers
group names is a which-key thing
this shouldn't be done from neorg

you can just do something like this:

vim.api.nvim_create_autocmd("BufEnter",{
pattern="*.norg",
callback=function()
wk.register(...,{buffer=true})
end
})

[osamuaoki]

Very true. autocmd is the way to do this. Thanks

[ddbrierton]

I’m pleased I stumbled across this as I was trying to solve exactly the same problem. Two things, though. (1) I think it needs to be buffer = 0 not buffer = true in the opts table, the second argument to wk.register(). I have this:

vim.api.nvim_create_autocmd("BufEnter", {
  pattern = "*.norg",
  callback = function()
    require("which-key").register({
      ["<leader>n"] = { name = "+neorg" },
      ["<leader>ni"] = { name = "+insert" },
      ["<leader>nl"] = { name = "+list" },
      ["<leader>nm"] = { name = "+mode" },
      ["<leader>nn"] = { name = "+note" },
      ["<leader>nt"] = { name = "+task" },
    }, { buffer = 0 })
  end,
})

(2) Backspace no longer works to go back once I’m in insert/list/mode/note/task. No other which-key groups are affected, backspace continues to work as expected. So <leader> n <bs> works as expected, but <leader> n i <bs> leaves me stuck in the +insert group, and I have to either choose one of the options or <esc> to close which-keys completely.

Did you notice the same?

[weberam2]

OMG THANK YOU!