How can you set a keymap to execute lua code?

[MFlossmann]

I'm currently in the process of porting my Astronvim config to nixvim (I'm still not sure if I can carry through with it). Since astronvim has a lot of custom lua code for simple actions, like closing a buffer, I created a custom myutils plugin that's supposed to implement this complex logic.

But when I config the following in the keymaps:

keymaps = [
  {
    key = "<leader>c";
    action = "require('myutils.buffer').close()";
    options.desc = "Close buffer";
  }
]

Then, neovim doesn't actually call the lua function. The resulting mapping in the init.lua copies the string, when it actually should input the raw lua code:

{
  ["action"] = "require('myutils.buffer').close()",
  ["key"] = "<leader>c",
  ["options"] = { ["desc"] = "Close buffer" },
},

I'm new to nix and nixvim (therefore the learning project) and the documentation didn't help me too much here, unfortunately. :(

Since this is some basic stuff, I'd have liked to define these mappings not where I define the utils plugin.

[MattSturgeon]

Use nixvim's "raw type":

```nix
action.__raw = "require('myutils.buffer').close";

Or

action.__raw = "function() require('myutils.buffer').close() end";

You can use helpers.mkRaw too (which does the same as above)

[MFlossmann]

Thanks! I found references to something called __raw, but couldn't find it in the documentation. I'd be happy to contribute a bit by extending the documentation e.g. to mention the answer to my question.

Are contributions solely to the documentations welcome? Is there a specific process to follow, or should I just create a PR?

[MattSturgeon]

Are contributions solely to the documentations welcome?

Definitely!

Is there a specific process to follow, or should I just create a PR?

Just a PR, yes. Anything we're particular about can be handled in PR reviews 👍

[MattSturgeon]

We do have some mention of the raw type throughout the docs, particularly the user-guides section. But I agree it can definitely be made clearer and more obvious.