How to load the global "vim" object so lua-language-server stops complaining

Question

Here is how I start the server:

-- LSP
vim.lsp.start({
  name = 'lua-language-server',
  cmd = { 'lua-language-server' },
  root_dir = vim.fs.dirname(vim.fs.find({'.git', '.vim', 'nvim'}, { upward = true })[1])
})

This is fine. So now I load a lua file in vim, and one that takes advantage of the vim global object that nvim loads somewhere into the lua engine.

My linter doesn't have this library loaded, so it complains about the unset global. My lua code is able to run fine despite these linter warnings, of course.

How can I fix this? How can I straighten out the difference between my TRUE project root (effectively somewhere in nvim?) and my expressed one.

---

Idk if this helps:

:!lua-language-server --version
3.6.22

Answer 1

To recognize global objects:

vim.lsp.start({
  name = 'lua-language-server',
  cmd = { 'lua-language-server' },
  root_dir = vim.fs.dirname(vim.fs.find({'.git', '.vim', 'nvim'}, { upward = true })[1]),
  settings = { Lua = { diagnostics = { globals = {'vim'} } } },
})

Alternatively, use a .luarc.json file for workspace configs.

{
    "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
    "diagnostics.globals": ["vim"]
}

See https://github.com/LuaLS/lua-language-server/wiki/Settings for more settings. You might be interested in #workspace library

For vim development, the above suppress warnings. The lsp does not know what's in the vim global. I use neodev plugin for neovim lua development.

You can also look at configurations from lspconfig here and here. I think most people just install the extension, but you should be able to adapt it if you don't want to install it.