Moving all keys to one file

[synic]

I've got it working, but I'm sure there's some jank. Wondering if there's a better way.

Here's what my keymap.lua file looks like:

-- keymap.lua
module = {}

module.neogit = {
  {
    "<leader>gs",
    function()
      require("ao.modules.sourcecontrol").neogit_open()
    end,
    desc = "git status",
  },
}

return module

and here's what sourcecontro.lua looks like:

-- sourcecontrol.lua
local utils = require("ao.utils")
local keymap = require("ao.keymap")

local module = {}

-- Open NeoGit
--
-- This function goes through all the buffers and closes any that are
-- the neogit status buffer, and _then_ opens NeoGit. This is because if you
-- open neogit on one tab, and leave it open, and then try to open neogit again on
-- another tab, nothing will happen. NeoGit is already open, even if you can't see it.
module.neogit_open = function()
  for _, buf in pairs(vim.api.nvim_list_bufs()) do
    if vim.api.nvim_buf_get_option(buf, "filetype") == "NeogitStatus" then
      vim.api.nvim_buf_delete(buf, { force = true })
    end
  end
  require("neogit").open({ cwd = "%:p:h" })
end

return utils.table_concat(module, {
  {
    "NeogitOrg/neogit",
    opts = { kind = "vsplit" },
    keys = keymap.neogit,
    dependencies = { "nvim-lua/plenary.nvim", "sindrets/diffview.nvim" },
  },
  {}, -- this has to be here or lazy.vim throws an error about `find` on a nil value
})

I have to do the anonymous function as the callback in keymap.lua to avoid a circular dependeny. Also, the module has to have at least two plugins (or an empty table)at the end of the returned table), or lazy.nvim complains about find being called on a nil value. No idea why.

I'm returning a module with plugin specs, but also with functions. Maybe that conflicts with lazy.nvim, I am not sure.

Is there a better way to do this?

[abeldekat]

Hi @synic,

You would not need the utils.table_concat when using the import functionality of lazy.nvim. See LazyVim for inspiration.

Is there a reason to have all keymaps in one file? After all, you define them as Lazy Key Mappings. I would advise the simple approach, having the lazy keys in the spec of the plugin.

Given your code examples, you could break the dependency by using callback functions. For example:

module.neogit = function(action)
  return {
    "<leader>gs",
    action,
    desc = "git status",
  }
end

{
    "NeogitOrg/neogit",
    opts = { kind = "vsplit" },
    keys = {keymap.neogit(function module.neogit_open() end)},
    dependencies = { "nvim-lua/plenary.nvim", "sindrets/diffview.nvim" },
  },

[synic]

You would not need the utils.table_concat when using the import functionality of lazy.nvim.

I am trying to have both plugins and functions in the same module. I have it set up so that a "module" is a collection of related plugins. There may be both definitions in the module, and functions that are callbacks for keybindings. But I want to export the functions so they can be used in the keymap file, while still preserving the lazy.setup('modules') automatic import stuff. This is why I'm using table_concat

I think your solution would work, but it has the downside of needing a function for every key. Which is maybe not a big deal but I'll have to think about it.

[synic]

Nevermind, I gave up on trying to put it in one file so I moved it back to the plugins definitions.

After I did that, however, I think I thought of what is probably the best solution, and that is to defined partial keys in the main keymap file and use identifiers. That way the keymap file describes what keys should be used, but the plugin decides what the key actually does (callback, etc).

Something like this:

-- keymap.lua

local keys = {
  { id = 'telescope_git_files', key='<space>f', desc='search git files', mode = { 'n' } }
}

And, then in telescope.lua:

-- telescope.lua
local utils = require('someutils')
local keymap = require('keymap')
local keys = utils.parse_keymap(keymap)

return {
  {
    "nvim-telescope/telescope.nvim",
    keys = {
      keys.get('telescope_git_files', require('telescope.builtin').git_files()),
    }
  }
}