Anything I can do to avoid spurious undefined-field warning?

[proofer]

In a Neovim plugin config file, I'm getting an undefined-field server_capabilities warning on each of two lines containing:

... client.server_capabilities. ...

where a few lines before:

local client = vim.lsp.get_client_by_id(event.data.client_id)

and the plugin works OK.
Can I avoid the warnings without having to have two instances of:

---@diagnostic disable-next-line: undefined-field

?

[adigitoleo]

I get this all over the place in Neovim for things like uv.sleep() for some reason.

[tomlau10]

In a recent issue: #2785, the author (he uses neovim) has encountered some annoying behavior related to the return value type of uv.fs_stat(). And after some digging, it's related to luvit-meta definitions plugins that he used. After he switched the annotation source, it fixes that behavior.

Would it just happen that you're using a luvit-meta plugin for the uv definition as well 😂 ? Maybe you can try switching the annotation source of the uv library? @adigitoleo

[adigitoleo]

I don't use that plugin. But it was a NeoVim config issue, I didn't use the correct way to let luals know about the neovim runtime files, which is to use vim.env.VIMRUNTIME. So for me it is now solved.

#1688 (reply in thread)

[tomlau10]

neovim/neovim#26268, seems that starting from some version of neovim, it doesn't bundle with a libuv meta annotation anymore. There are some technical problems and decisions to be made as described in the issue. And at the moment users have to download and set it in their configs. 😕

So if you haven't done anything about the libuv annotation settings, then uv.sleep is expected to be undefined 😅 (LuaLS cannot find a definition for it). Just like when I do not setup a .luarc.json for the neovim folder and open it directly in vscode, all vim.uv.* are reported as undefined:

[tomlau10]

I didn't notice your reply when I am writing up my own 😂 Glad that your problem is solved 👍

[adigitoleo]

This comment provides a workaround, but not a solution, for how to ignore e.g. missing-fields globally, which is NOT a good idea for long term. This generally indicates either a luals configuration issue or a problem with the code.

https://www.reddit.com/r/neovim/comments/16gd5zp/suppress_missing_fields_lsp_warnings_lualsp_and/

lspconfig.lua_ls.setup {
    settings = {
        Lua = { 
            diagnostics = {

                -- ... other configuration ...

                disable = {"missing-parameters", "missing-fields"}
            },
    },
}

[adigitoleo]

Ideally there would be a way to do this per-namespace but I have no idea about that.

[tomlau10]

Whenever there are missing-field warnings for some built-in function, I believe there must be something wrong in the settings: 🤔

• it can be incorrect runtime path in the .luarc.json (vscode projects use this file to specify luals settings)
  https://luals.github.io/wiki/settings/#runtimepath
• I personally will also set runtime.pathStrict = true to restrict luals only search my specified runtime paths, this avoids luals incorrectly require incorrect modules with same name.
• You may also have to set the workspace.library if you need to use some built-in / library meta files
  https://luals.github.io/wiki/settings/#workspacelibrary

But as I said I use vscode, and it is required set them correctly in a .luarc.json of a project / workspace. I don't know if neovim uses the same thing.

[adigitoleo]

Yeah I had incorrect neovim config settings which did not detect the neovim runtime files properly. See #2698 (reply in thread), sorry for making this into a mess over multiple comments.

[adigitoleo]

have to set the workspace.library

This was the key for me in NeoVim 0.10

[tomlau10]

undefined-field server_capabilities warning on each of two lines containing:

I know nothing about neovim (I use vscode), I just downloaded neovim from github's release page, extracted the zip, and then open the nvim-win64\share\nvim\runtime\lua as a workspace in vscode, and try to find the definition of vim.lsp.get_client_by_id

• it is defined here: https://github.com/neovim/neovim/blob/master/runtime/lua/vim/lsp.lua#L700-L701
• and it returns the class vim.lsp.Client which is defined here: https://github.com/neovim/neovim/blob/master/runtime/lua/vim/lsp/client.lua
• and this vim.lsp.Client has the field server_capabilities: https://github.com/neovim/neovim/blob/master/runtime/lua/vim/lsp/client.lua#L172

If everything works as expected, LuaLS should not throw the warnings undefined-field server_capabilities 😕
Can you do a goto definition at the get_client_by_id then the vim.lsp.Client, to see if the definition of this class has the server_capabilities field in your copy of neovim? @proofer

---

Just some wild guess

LuaLS has a setting on workspace.maxPreload: https://luals.github.io/wiki/settings/#workspacemaxpreload
The default value is 5000 files. If somehow your workspace contains too much file, then LuaLS may not preload the runtime/lua/vim/lsp/client.lua correctly, and then it may warn some classes as undefined, until you open that file manually. 🤔
If that's the case, you can increase the preload limit, or set some ignore path in the settings such that LuaLS will not load too many unnecessary files.