mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-26 12:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(lsp): use method type annotations for parameters

Browse Source
This commit is contained in:
Maria José Solano
2025-04-20 14:54:31 -07:00
committed by Christian Clason
parent 351613bc1f
commit d55330bcd1
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/lua/vim/lsp.lua
View File

@@ -43,7 +43,7 @@ lsp._resolve_to_request = {
---@private ---@private
--- Called by the client when trying to call a method that's not --- Called by the client when trying to call a method that's not
--- supported in any of the servers registered for the current buffer. --- supported in any of the servers registered for the current buffer.
---@param method (string) name of the method ---@param method (vim.lsp.protocol.Method.ClientToServer) name of the method
function lsp._unsupported_method(method) function lsp._unsupported_method(method)
local msg = string.format( local msg = string.format(
'method %s is not supported by any of the servers registered for the current buffer', 'method %s is not supported by any of the servers registered for the current buffer',
@@ -1183,7 +1183,7 @@ api.nvim_create_autocmd('VimLeavePre', {
--- buffer. --- buffer.
--- ---
---@param bufnr (integer) Buffer handle, or 0 for current. ---@param bufnr (integer) Buffer handle, or 0 for current.
---@param method (string) LSP method name ---@param method (vim.lsp.protocol.Method.ClientToServer.Request) LSP method name
---@param params? table|(fun(client: vim.lsp.Client, bufnr: integer): table?) Parameters to send to the server ---@param params? table|(fun(client: vim.lsp.Client, bufnr: integer): table?) Parameters to send to the server
---@param handler? lsp.Handler See |lsp-handler| ---@param handler? lsp.Handler See |lsp-handler|
--- If nil, follows resolution strategy defined in |lsp-handler-configuration| --- If nil, follows resolution strategy defined in |lsp-handler-configuration|
@@ -1246,7 +1246,7 @@ end
---@since 7 ---@since 7
--- ---
---@param bufnr (integer) Buffer handle, or 0 for current. ---@param bufnr (integer) Buffer handle, or 0 for current.
---@param method (string) LSP method name ---@param method (vim.lsp.protocol.Method.ClientToServer.Request) LSP method name
---@param params? table|(fun(client: vim.lsp.Client, bufnr: integer): table?) Parameters to send to the server. ---@param params? table|(fun(client: vim.lsp.Client, bufnr: integer): table?) Parameters to send to the server.
--- Can also be passed as a function that returns the params table for cases where --- Can also be passed as a function that returns the params table for cases where
--- parameters are specific to the client. --- parameters are specific to the client.
@@ -1317,7 +1317,7 @@ end
---@since 7 ---@since 7
--- ---
---@param bufnr (integer|nil) The number of the buffer ---@param bufnr (integer|nil) The number of the buffer
---@param method (string) Name of the request method ---@param method (vim.lsp.protocol.Method.ClientToServer.Notification) Name of the request method
---@param params (any) Arguments to send to the server ---@param params (any) Arguments to send to the server
--- ---
---@return boolean success true if any client returns true; false otherwise ---@return boolean success true if any client returns true; false otherwise

2
runtime/lua/vim/lsp/client.lua
View File

@@ -1100,7 +1100,7 @@ end
--- @private --- @private
--- Handles a request from an LSP server by invoking the corresponding handler. --- Handles a request from an LSP server by invoking the corresponding handler.
--- ---
--- @param method (string) LSP method name --- @param method (vim.lsp.protocol.Method.ServerToClient) LSP method name
--- @param params (table) The parameters for that method --- @param params (table) The parameters for that method
--- @return any result --- @return any result
--- @return lsp.ResponseError error code and message set in case an exception happens during the request. --- @return lsp.ResponseError error code and message set in case an exception happens during the request.

4
runtime/lua/vim/lsp/rpc.lua
View File

@@ -482,7 +482,7 @@ local function public_client(client)
--- Sends a request to the LSP server and runs {callback} upon response. --- Sends a request to the LSP server and runs {callback} upon response.
--- ---
---@param method (string) The invoked LSP method ---@param method (vim.lsp.protocol.Method.ClientToServer.Request) The invoked LSP method
---@param params (table?) Parameters for the invoked LSP method ---@param params (table?) Parameters for the invoked LSP method
---@param callback fun(err: lsp.ResponseError?, result: any) Callback to invoke ---@param callback fun(err: lsp.ResponseError?, result: any) Callback to invoke
---@param notify_reply_callback? fun(message_id: integer) Callback to invoke as soon as a request is no longer pending ---@param notify_reply_callback? fun(message_id: integer) Callback to invoke as soon as a request is no longer pending
@@ -493,7 +493,7 @@ local function public_client(client)
end end
--- Sends a notification to the LSP server. --- Sends a notification to the LSP server.
---@param method (string) The invoked LSP method ---@param method (vim.lsp.protocol.Method.ClientToServer.Notification) The invoked LSP method
---@param params (table?) Parameters for the invoked LSP method ---@param params (table?) Parameters for the invoked LSP method
---@return boolean `true` if notification could be sent, `false` if not ---@return boolean `true` if notification could be sent, `false` if not
function result.notify(method, params) function result.notify(method, params)