Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: instructions for adding a plugin to Nvim with Lua #168

Closed
mkvl0 opened this issue May 9, 2024 · 4 comments
Closed

docs: instructions for adding a plugin to Nvim with Lua #168

mkvl0 opened this issue May 9, 2024 · 4 comments

Comments

@mkvl0
Copy link

mkvl0 commented May 9, 2024

There is an example of writing a plugin which adds Hello command to Nvim

On the step 3 "Add the following plugin to Nvim:" there is a code example written in Vimscript instead of Lua.

It would be great to have the same example but written in Lua.

Ideally, an example can be extended to have more details for developers who never work with go-client and plugin system before. Specifically, it would be great to give more details on the step "Add the following plugin to Nvim" since it does not clarify where exactly do we need to add plugin (what file, folder, etc. and how to register plugin so Neovim will launch it).

@justinmk
Copy link
Member

It would be great to have the same example but written in Lua.

sure, that's an easy enough change to make.

Ideally, an example can be extended to have more details for developers who never work with go-client and plugin system before. Specifically, it would be great to give more details on the step "Add the following plugin to Nvim"

Probably the best reference is the _test.go examples in https://github.com/neovim/go-client/tree/main/nvim/plugin

Long-term (hopefully before end of 2024), the answer is to vastly simplify "remote plugins" as outlined in #167

@justinmk
Copy link
Member

Can you try the steps outlined here and report your experience here?

@justinmk justinmk changed the title Update an instruction on adding the plugin to Nvim with Lua code docs: instructions for adding a plugin to Nvim with Lua May 13, 2024
@garyburd
Copy link
Contributor

garyburd commented May 13, 2024

The code in my comment was not compiled or tested. The comment is missing the Lua side of the code. I'll post a working example in a few days.

@garyburd
Copy link
Contributor

I posted an example of a plugin written in Lua calling functions written in Go. Example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants