how to access parameter of nvim_create_user_command

Question

I am writing a lua function as custom command for my neovim config.

As the documentation says "The function is called with a single table argument that contains the following keys", but how can i access these keys when the table is not defined to a variable.

I tried calling the function like this:

vim.api.nvim_create_user_command('Build', fn_build(args), { nargs='?' })

and access the values with:

function fn_build(args)
  run = args["args"] or nil
end

but i would get a nil error.

@Ani commented:

Try to see if there is anything close to this, in github.com/nanotee/nvim-lua-guide

I found the guide, but it didn't helped me to fix it. I'm not sure if desc is the right variable to use. And how would i even use it. The guide says:

Two additional attributes are available:

desc allows you to control what gets displayed when you run :command {cmd} on a command defined as a Lua callback. Similarly to keymaps, it is recommended to add a desc key to commands defined as Lua functions.

force is equivalent to calling :command! and replaces a command if one with the same name already exists. It is true by default, unlike its Vimscript equivalent.

Am i blind and overseeing something?

Please point me in the right direction

Try to see if there is anything close to this, in github.com/nanotee/nvim-lua-guide — Ani
– Ani, Commented Sep 6, 2022 at 7:19

Ural Bayhan · Accepted Answer · 2022-12-06 18:36:54Z

4

You are calling the function fn_build and registering the return value. Instead you should just pass the function as a parameter. Try the following

vim.api.nvim_create_user_command('Build', fn_build, { nargs='?' })

answered Dec 6, 2022 at 18:36

Ural Bayhan

635 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Ludo · Accepted Answer · 2023-02-27 21:26:12Z

3

As supermeia said your function should receive opts, you should be able to do it directly when you create your command if you don't want to change your fn_build function, like this:

 vim.api.nvim_create_user_command(
  function(opts)
    fn_build(opts.args)
  end,
  { nargs = '?' }
)

answered Feb 27, 2023 at 21:26

Ludo

514 bronze badges

Comments

supermeia · Accepted Answer · 2023-02-07 22:36:55Z

2

fn_build should receive opts as an argument try the following:

function fn_build(opts)
    run = opts.args or nil
end

answered Feb 7, 2023 at 22:36

supermeia

211 bronze badge

Collectives™ on Stack Overflow

how to access parameter of nvim_create_user_command

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related