docs(lua_ls) Fix broken example setup when workspace_folders are not used #3133
Conversation
| local path = client.workspace_folders[1].name | ||
| if vim.loop.fs_stat(path..'/.luarc.json') or vim.loop.fs_stat(path..'/.luarc.jsonc') then | ||
| return | ||
| end |
There was a problem hiding this comment.
@glepnir Actually I wonder if the current example configuration makes much sense anymore. From https://luals.github.io/wiki/configuration/:
The language server loads its settings from one of the following sources, in order of priority:
- The file specified by --config-path.
- A .luarc.json file in the workspace.
- The configuration file sent from the LSP client (like settings.json from VS Code).
So the if at the beginning should not be required at all anymore.
And even on_init is probably not necessary: The whole config can just be passed in settings as shown here: https://luals.github.io/wiki/configuration/#neovim
What do you think?
There was a problem hiding this comment.
Here's what I'm using: https://github.com/lewis6991/dotfiles/blob/main/config%2Fnvim%2Flua%2Flewis6991%2Flsp.lua#L137-L146
Basically if there's no .luarc.json which configures the - workspace then apply some default settings which include $VIMRUNTIME. You shouldn't include this unconditionally.
There was a problem hiding this comment.
You shouldn't include this unconditionally.
But according to the lua_ls documentation that shouldn't be the case: If the server finds a .luarc.json it will not use the config sent from the LSP client (neovim).
Without this fix I get errors on startup and the config is not applied properly.