vim.lsp.ClientConfig

Map overriding the default capabilities defined by |vim.lsp.protocol.makeclientcapabilities()|, passed to the language server on initialization. Hint: use makeclientcapabilities() and modify its result.

• Note: To send an empty dictionary use |vim.empty_dict()|, else it will be encoded as an

array.

Command string[] that launches the language server (treated as in |jobstart()|, must be absolute or on $PATH, shell constructs like "~" are not expanded), or function that creates an RPC client (or an in-process |lsp-server|). Function receives a dispatchers table and the resolved config, and must return an object in the form of |vim.lsp.rpc.Client|.

Example (list):

 cmd = { 'flow', 'lsp' }

Example (function):

 cmd = function(dispatchers, config)
   local cmd = vim.fn.executable('flow') == 1 and { 'flow', 'lsp' } or { 'npx', '--no-install', 'flow', 'lsp' }
   return vim.lsp.rpc.start(cmd, dispatchers)
 end

• See |vim.lsp.rpc.Client|.
• For TCP there is a builtin RPC client factory: |vim.lsp.rpc.connect()|

Directory where the cmd process is launched when cmd is a string array. Defaults to root_dir when available, then the current working directory.

Environment variables passed to the LSP process on spawn. Non-string values are coerced to string. Example:

 { PORT = 8080, HOST = '0.0.0.0' }

Map of client-defined commands overriding the global |vim.lsp.commands|.

Daemonize the server process so that it runs in a separate process group from Nvim. Nvim will shutdown the process on exit, but if Nvim fails to exit cleanly this could leave behind orphaned server processes. (default: true)

Decides if/when to force-stop the server after sending the "shutdown" request. See |Client:stop()|. Note: when Nvim itself is exiting,

• false: Nvim will not force-stop LSP server(s).
• true: Nvim will force-stop LSP server(s) that did not comply with the "shutdown" request.
• number: Nvim will wait up to exit_timeout milliseconds before performing force-stop.

(default: false)

Experimental client flags:

Map of LSP method names to |lsp-handler|s.

Values to pass in the initialization request as initializationOptions. See initialize in the LSP spec.

Name in logs and user messages. (default: client-id)

Called "position encoding" in LSP spec. The encoding that the LSP server expects, used for communication. Not validated. Can be modified in on_init before text is sent to the server.

Callback invoked when client attaches to a buffer.

Callback invoked on client exit.

• code: exit code of the process
• signal: number describing the signal used to terminate (if any)
• client_id: client handle

Callback invoked after LSP "initialize", where result is a table of capabilities and anything else the server may send. For example, clangd sends init_result.offsetEncoding if capabilities.offsetEncoding was sent to it. You can only modify the client.offset_encoding here before any notifications are sent.

Directory where the LSP server will base its workspaceFolders, rootUri, and rootPath on initialization.

Map of language server-specific settings, decided by the client. Sent to the LS if requested via workspace/configuration. Keys are case-sensitive.

Passed directly to the language server in the initialize request. Invalid/empty values will (default: "off")

List of workspace folders passed to the language server. For backwards compatibility rootUri and rootPath are derived from the first workspace folder in this list. Can be null if the client supports workspace folders but none are configured. See workspaceFolders in LSP spec.

Server requires a workspace (no "single file" support). Note: Without a workspace, cross-file features (navigation, hover) may or may not work depending on the language server, even if the server doesn't require a workspace. (default: false)