Help a Neovim newbie set up which-key

[gldtn]

Hello, I just started on my Nvim journey and I'm having some difficulty getting which-key setup.

Here is my Nvim file tree:

plugins/which-key.lua I have:

return
{
    "folke/which-key.nvim",
    event = "VeryLazy",
    init = function()
        vim.o.timeout = true
        vim.o.timeoutlen = 300
      end,
      opts = {
          window = { border = "single" },
      },
}

config/keymaps.lua:

function Map(mode, lhs, rhs, opts)
    local options = { noremap = true, silent = true }
    if opts then
        options = vim.tbl_extend("force", options, opts)
    end
    vim.keymap.set(mode, lhs, rhs, options)
end

-- Leader key, remap to space
Map("", "<Space>", "<Nop>")
vim.g.mapleader = " "
vim.g.maplocalleader = " "

local wk = require("which-key")                                       
wk.register({                                                         
    ["<leader>"] = {                                                  
        f = {                                                         
            name = "+file",                                           
            f = { "<cmd>Telescope find_files<cr>", "Find File" },     
            r = { "<cmd>Telescope oldfiles<cr>", "Open Recent File" },
            n = { "<cmd>enew<cr>", "New File" },                      
        },                                                            
    },                                                                
})

But I get an error, which I'm not sure how to resolve it:

Error detected while processing /Users/gldtn/.config/nvim/init.lua:
E5113: Error while calling lua chunk: /Users/gldtn/.config/nvim/lua/config/keymaps.lua:109: module 'which-key' not found:
        no field package.preload['which-key']
        no file './which-key.lua'
        no file '/opt/homebrew/share/luajit-2.1/which-key.lua'
        no file '/usr/local/share/lua/5.1/which-key.lua'
        no file '/usr/local/share/lua/5.1/which-key/init.lua'
        no file '/opt/homebrew/share/lua/5.1/which-key.lua'
        no file '/opt/homebrew/share/lua/5.1/which-key/init.lua'
        no file './which-key.so'
        no file '/usr/local/lib/lua/5.1/which-key.so'
        no file '/opt/homebrew/lib/lua/5.1/which-key.so'
        no file '/usr/local/lib/lua/5.1/loadall.so'
stack traceback:
        [C]: in function 'require'
        /Users/gldtn/.config/nvim/lua/config/keymaps.lua:109: in main chunk
        [C]: in function 'require'
        /Users/gldtn/.config/nvim/init.lua:2: in main chunk
Press ENTER or type command to continue

checkhealth which-key:

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

WhichKey: checking conflicting keymaps ~
- OK No conflicting keymaps found

Can someone please describe what I'm doing wrong? Thank you!

[santoso-wijaya]

I just used which-key to set up keymaps for nvim-hop yesterday. I did it directly in the plugin script where I installed hop, rather than splitting it to a different script. That worked for me.

Here's what I did: https://github.com/santoso-wijaya/lazyvim-config/blob/6f20c610f966edc56cc4181ad156246f67b1f341/lua/plugins/hop.lua#L41-L57

[alxndr]

Is the keymaps file being run before the plugin files?

[gldtn]

When I posted this question, I was on my very early days into nvim. While I'm still new I think this is how it goes..

As far as I understand, init.lua runs first, so if you require your keymaps.lua inside of it, it will load before any other plugins. Keys inside of plugins will load after and also depends on how your are calling your plugin, for example, lazy loading, etc.. So if I set a plugin to lazy = true using lazy.nvim, I generally set it's keymaps separate inside my keymaps.lua file. This way I can call the plugin only when needed.

For the experts out there, please correct me if I'm wrong.