undefined global 'vim' in lua-language-server - coc.nvim

Question

This snippet gives a warning: local api = vim.api #Undefined global 'vim'

my CocConfig:

`  "languageserver": {
    "lua": {
      "command": "/home/manas/.config/coc/extensions/coc-sumneko-lua-data/sumneko-lua-ls/extension/server/bin/Linux/lua-language-server",
      "args": [
        "-E",
        "/home/manas/.config/coc/extensions/coc-sumneko-lua-data/sumneko-lua-ls/extension/server/main.lua"
      ],
      "filetypes": [
        "lua"
      ],
      "rootPatterns": [
        ".git/"
      ],
      "settings": {
        "Lua": {
          "workspace": {
            "library": {
              "/usr/share/nvim/runtime/lua": true,
              "/usr/share/nvim/runtime/lua/vim": true,
              "/usr/share/nvim/runtime/lua/vim/lsp": true
            },
            "maxPreload": 2000,
            "preloadFileSize": 1000
          },
          "runtime": {
            "version": "5.4.1"
          },
          "diagnostics": {
            "disable": [
              "undefined-global",
              "lowercase-global",
              "unused-local",
              "unused-vararg",
              "trailing-space"
            ],
            "globals": [
              "vim",
              "hs",
              "it",
              "describe",
              "before_each",
              "after_each"
            ]
          }
        }
      }
    }
  }
`

Answer 1

1. Follow the process from URL: https://github.com/sumneko/lua-language-server/wiki/Build-and-Run, to install lua-language-server manually.

2. Startup neovim, enter command: :CocConfig。

3. Edit the file: coc-settings.json

{
  "languageserver": {
    "lua": {
      "command": "/home/alanjui/.local/share/lua-language-server/bin/Linux/lua-language-server",
      "args": [
        "-E",
        "/home/alanjui/.local/share/lua-language-server/bin/Linux/main.lua"
      ],
      "filetypes": ["lua"],
      "settings": {
        "Lua": {
          "workspace.library": {
            "/usr/share/nvim/runtime/lua": true,
            "/usr/share/nvim/runtime/lua/vim": true,
            "/usr/share/nvim/runtime/lua/vim/lsp": true
          },
          "diagnostics": {
            "globals": [ "vim" ]
          }  
        }
      }
    }
  }
}

Answer 2

All coc-lua needs is a "Lua.diagnostics.globals": ["vim"] in your coc-settings.json.

Answer 3

1. Install coc-sumneko-lua.

2. Add the following line to your coc-setting.json.

   "sumneko-lua.enableNvimLuaDev": true,
   

Answer 4

actually lua lsp itself has clearly explains what to do in the docs here.

1. You install coc-lua by running :CocInstall coc-lua
2. open coc-settings by running :CocConfig
3. as stated in the linked docs above just add the following
   -> "Lua.runtime.version":"LuaJIT"
   ->

    "Lua.workspace.library":[
        "<value of $VIMRUNTIME variable>"
     (you can just do <c-r>=$VIMRUNTIME to insert it there)
    ]

4. after all just do a :CocRestart and you are good to go