Document how to let the lua LSP find local libraries, such as plenary

[Murderlon]

This template is great, it saved a lot of time.

There is just one thing I don't understand, which is how to make lua_ls (language server for lua) understand where to find the code for plenary. By default plenary is put into /tmp.

I tried to create a .luarc.json to find it but I failed:

{
  "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
  "diagnostics.globals": ["describe", "it"],
  "workspace.library": ["?.lua", "?/init.lua", "/tmp/plenary.nvim/lua/plenary/?.lua"]
}

Since the docs of plenary are so limited and the LSP doesn't know anything about the available methods and imports of plenary, it's quite hard to develop locally.

[ellisonleao]

hey @Murderlon thanks for the feedback. I use this plugin which already loads the plugins I have (including plenary) in the workspace. Maybe it can help you

[Murderlon]

I use LazyVim from folke which includes that plugin. It's great for vim api's, but I'm talking about plenary. It's added by default in this project but the LSP doesn't understand it exists. So it doesn't know which imports exists, which methods and so on. I was hoping we could add a .luarc.json to this project which sets this up.

[ellisonleao]

Can you clarify what places are you going to use plenary for this template, please?

[Murderlon]

When I import plenary in lua/plugin_name.lua the LSP is not aware plenary exists:

When I import plenary in my nvim config the LSP is aware that the plugin exists:

I think it would be nice if this project included either docs or a config file to make the LSP understand where to find plenary in the files setup by this template.

[redoxahmii]

Same issue here did you ever find a solution to this?

When I import plenary in lua/plugin_name.lua the LSP is not aware plenary exists:

When I import `plenary` in my nvim config the LSP is aware that the plugin exists: I think it would be nice if this project included either docs or a config file to make the LSP understand where to find plenary in the files setup by this template.