neovim / go-client

Nvim Go client
https://pkg.go.dev/github.com/neovim/go-client
Apache License 2.0
561 stars 37 forks source link

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

Closed kovalevsky0 closed 2 months ago

kovalevsky0 commented 2 months ago

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 commented 2 months ago

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 https://github.com/neovim/go-client/issues/167

justinmk commented 2 months ago

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

garyburd commented 2 months ago

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 commented 2 months ago

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