fix(lsp): _get_workspace_folders does not handle root_dir() function #36071

* fix(lsp): type of root_dir should be annotated with string|fun|nil
* feat(lsp): support root_dir as function in _get_workspace_folders
* feat(lsp): let checkhealth support root_dir() function

Examples:

    vim.lsp: Active Clients ~
    - lua_ls (id: 1)
      - Version: <Unknown>
      - Root directories:
          ~/foo/bar
          ~/dev/neovim

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
This commit is contained in:
atusy
2025-10-12 08:01:05 +09:00
committed by GitHub
parent 020d5e0f7e
commit 97ab24b9c7
6 changed files with 155 additions and 10 deletions

View File

@@ -117,7 +117,7 @@ local all_clients = {}
--- @field on_init? elem_or_list<fun(client: vim.lsp.Client, init_result: lsp.InitializeResult)>
---
--- Directory where the LSP server will base its workspaceFolders, rootUri, and rootPath on initialization.
--- @field root_dir? string
--- @field root_dir? string|fun(bufnr: integer, on_dir:fun(root_dir?:string))
---
--- Map of language server-specific settings, decided by the client. Sent to the LS if requested via
--- `workspace/configuration`. Keys are case-sensitive.
@@ -190,7 +190,7 @@ local all_clients = {}
--- @field requests table<integer,{ type: string, bufnr: integer, method: string}?>
---
--- See [vim.lsp.ClientConfig].
--- @field root_dir string?
--- @field root_dir? string|fun(bufnr: integer, on_dir:fun(root_dir?:string))
---
--- RPC client object, for low level interaction with the client.
--- See |vim.lsp.rpc.start()|.
@@ -1367,6 +1367,27 @@ function Client:_remove_workspace_folder(dir)
end
end
--- Gets root_dir, waiting up to `ms` for a potentially async `root_dir()` result.
---
--- @param ms integer
--- @param buf integer
--- @return string|nil
function Client._resolve_root_dir(ms, buf, root_dir)
if root_dir == nil or type(root_dir) == 'string' then
return root_dir --[[@type string|nil]]
end
local dir = nil --[[@type string|nil]]
root_dir(buf, function(d)
dir = d
end)
-- root_dir() may be async, wait for a result.
vim.wait(ms, function()
return not not dir
end)
return dir
end
-- Export for internal use only.
Client._all = all_clients