fix(test): typing

13 files changed, 174 insertions, 180 deletions

diff --git a/test/functional/helpers.lua b/test/functional/helpers.lua
index d1d26919a0..caa14a480b 100644
--- a/test/functional/helpers.lua
+++ b/test/functional/helpers.lua
@@ -15,7 +15,8 @@ local ok = global_helpers.ok
 local sleep = uv.sleep
 local fail = global_helpers.fail
 
-local module = {}
+--- @class test.functional.helpers: test.helpers
+local module = vim.deepcopy(global_helpers)
 
 local runtime_set = 'set runtimepath^=./build/lib/nvim/'
 module.nvim_prog = (os.getenv('NVIM_PRG') or global_helpers.paths.test_build_dir .. '/bin/nvim')
@@ -367,13 +368,6 @@ function module.feed(...)
   end
 end
 
---- @param ... string
-function module.rawfeed(...)
-  for _, v in ipairs({ ... }) do
-    nvim_feed(dedent(v))
-  end
-end
-
 ---@param ... string[]?
 ---@return string[]
 function module.merge_args(...)
@@ -583,7 +577,7 @@ function module.insert(...)
   nvim_feed('i')
   for _, v in ipairs({ ... }) do
     local escaped = v:gsub('<', '<lt>')
-    module.rawfeed(escaped)
+    module.feed(escaped)
   end
   nvim_feed('<ESC>')
 end
@@ -853,7 +847,7 @@ function module.exc_exec(cmd)
 end
 
 --- @param cond boolean
---- @param reason string
+--- @param reason? string
 --- @return boolean
 function module.skip(cond, reason)
   if cond then
@@ -1028,9 +1022,6 @@ function module.mkdir_p(path)
   return os.execute((is_os('win') and 'mkdir ' .. path or 'mkdir -p ' .. path))
 end
 
---- @class test.functional.helpers: test.helpers
-module = vim.tbl_extend('error', module, global_helpers)
-
 --- @return test.functional.helpers
 return function(after_each)
   if after_each then
diff --git a/test/functional/lua/fs_spec.lua b/test/functional/lua/fs_spec.lua
index 6821fe3c5e..a5cdfdc225 100644
--- a/test/functional/lua/fs_spec.lua
+++ b/test/functional/lua/fs_spec.lua
@@ -54,7 +54,7 @@ describe('vim.fs', function()
     it('works', function()
       local test_dir = nvim_dir .. '/test'
       mkdir_p(test_dir)
-      local dirs = {}
+      local dirs = {} --- @type string[]
       for dir in vim.fs.parents(test_dir .. '/foo.txt') do
         dirs[#dirs + 1] = dir
         if dir == test_build_dir then
@@ -70,6 +70,7 @@ describe('vim.fs', function()
     it('works', function()
       eq(test_build_dir, vim.fs.dirname(nvim_dir))
 
+      --- @param paths string[]
       local function test_paths(paths)
         for _, path in ipairs(paths) do
           eq(
@@ -97,6 +98,7 @@ describe('vim.fs', function()
     it('works', function()
       eq(nvim_prog_basename, vim.fs.basename(nvim_prog))
 
+      --- @param paths string[]
       local function test_paths(paths)
         for _, path in ipairs(paths) do
           eq(
@@ -292,7 +294,7 @@ describe('vim.fs', function()
       eq('/', vim.fs.normalize('/'))
     end)
     it('works with ~', function()
-      eq(vim.fs.normalize(vim.uv.os_homedir()) .. '/src/foo', vim.fs.normalize('~/src/foo'))
+      eq(vim.fs.normalize(assert(vim.uv.os_homedir())) .. '/src/foo', vim.fs.normalize('~/src/foo'))
     end)
     it('works with environment variables', function()
       local xdg_config_home = test_build_dir .. '/.config'
diff --git a/test/functional/lua/loader_spec.lua b/test/functional/lua/loader_spec.lua
index 4e42a18405..6f74385e45 100644
--- a/test/functional/lua/loader_spec.lua
+++ b/test/functional/lua/loader_spec.lua
@@ -73,12 +73,12 @@ describe('vim.loader', function()
       vim.loader.enable()
     ]]
 
-    local tmp1, tmp2 = (function(t)
-      assert(os.remove(t))
-      assert(helpers.mkdir(t))
-      assert(helpers.mkdir(t .. '/%'))
-      return t .. '/%/x', t .. '/%%x'
-    end)(helpers.tmpname())
+    local t = helpers.tmpname()
+    assert(os.remove(t))
+    assert(helpers.mkdir(t))
+    assert(helpers.mkdir(t .. '/%'))
+    local tmp1 = t .. '/%/x'
+    local tmp2 = t .. '/%%x'
 
     helpers.write_file(tmp1, 'return 1', true)
     helpers.write_file(tmp2, 'return 2', true)
diff --git a/test/functional/lua/overrides_spec.lua b/test/functional/lua/overrides_spec.lua
index ecbdde3bfd..428b2e0921 100644
--- a/test/functional/lua/overrides_spec.lua
+++ b/test/functional/lua/overrides_spec.lua
@@ -195,7 +195,7 @@ describe('print', function()
 end)
 
 describe('debug.debug', function()
-  local screen
+  local screen --- @type test.functional.ui.screen
 
   before_each(function()
     screen = Screen.new()
diff --git a/test/functional/lua/secure_spec.lua b/test/functional/lua/secure_spec.lua
index 7aed711b23..20e73b9693 100644
--- a/test/functional/lua/secure_spec.lua
+++ b/test/functional/lua/secure_spec.lua
@@ -11,8 +11,10 @@ local exec_lua = helpers.exec_lua
 local feed_command = helpers.feed_command
 local feed = helpers.feed
 local fn = helpers.fn
+local stdpath = fn.stdpath
 local pcall_err = helpers.pcall_err
 local matches = helpers.matches
+local read_file = helpers.read_file
 
 describe('vim.secure', function()
   describe('read()', function()
@@ -71,11 +73,11 @@ describe('vim.secure', function()
       ]],
       }
 
-      local trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      local trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('! %s', cwd .. pathsep .. 'Xfile'), vim.trim(trust))
       eq(vim.NIL, exec_lua([[return vim.secure.read('Xfile')]]))
 
-      os.remove(fn.stdpath('state') .. pathsep .. 'trust')
+      os.remove(stdpath('state') .. pathsep .. 'trust')
 
       feed_command([[lua vim.secure.read('Xfile')]])
       screen:expect {
@@ -100,12 +102,12 @@ describe('vim.secure', function()
       ]],
       }
 
-      local hash = fn.sha256(helpers.read_file('Xfile'))
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      local hash = fn.sha256(read_file('Xfile'))
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('%s %s', hash, cwd .. pathsep .. 'Xfile'), vim.trim(trust))
       eq(vim.NIL, exec_lua([[vim.secure.read('Xfile')]]))
 
-      os.remove(fn.stdpath('state') .. pathsep .. 'trust')
+      os.remove(stdpath('state') .. pathsep .. 'trust')
 
       feed_command([[lua vim.secure.read('Xfile')]])
       screen:expect {
@@ -131,7 +133,7 @@ describe('vim.secure', function()
       }
 
       -- Trust database is not updated
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(nil, trust)
 
       feed_command([[lua vim.secure.read('Xfile')]])
@@ -165,7 +167,7 @@ describe('vim.secure', function()
       }
 
       -- Trust database is not updated
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(nil, trust)
 
       -- Cannot write file
@@ -210,70 +212,70 @@ describe('vim.secure', function()
 
     it('trust then deny then remove a file using bufnr', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(helpers.read_file('test_file'))
+      local hash = fn.sha256(read_file('test_file'))
       local full_path = cwd .. pathsep .. 'test_file'
 
       command('edit test_file')
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='allow', bufnr=0})}]]))
-      local trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      local trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('%s %s', hash, full_path), vim.trim(trust))
 
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='deny', bufnr=0})}]]))
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('! %s', full_path), vim.trim(trust))
 
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='remove', bufnr=0})}]]))
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq('', vim.trim(trust))
     end)
 
     it('deny then trust then remove a file using bufnr', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(helpers.read_file('test_file'))
+      local hash = fn.sha256(read_file('test_file'))
       local full_path = cwd .. pathsep .. 'test_file'
 
       command('edit test_file')
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='deny', bufnr=0})}]]))
-      local trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      local trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('! %s', full_path), vim.trim(trust))
 
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='allow', bufnr=0})}]]))
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('%s %s', hash, full_path), vim.trim(trust))
 
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='remove', bufnr=0})}]]))
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq('', vim.trim(trust))
     end)
 
     it('trust using bufnr then deny then remove a file using path', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(helpers.read_file('test_file'))
+      local hash = fn.sha256(read_file('test_file'))
       local full_path = cwd .. pathsep .. 'test_file'
 
       command('edit test_file')
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='allow', bufnr=0})}]]))
-      local trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      local trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('%s %s', hash, full_path), vim.trim(trust))
 
       eq(
         { true, full_path },
         exec_lua([[return {vim.secure.trust({action='deny', path='test_file'})}]])
       )
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('! %s', full_path), vim.trim(trust))
 
       eq(
         { true, full_path },
         exec_lua([[return {vim.secure.trust({action='remove', path='test_file'})}]])
       )
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq('', vim.trim(trust))
     end)
 
     it('deny then trust then remove a file using bufnr', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(helpers.read_file('test_file'))
+      local hash = fn.sha256(read_file('test_file'))
       local full_path = cwd .. pathsep .. 'test_file'
 
       command('edit test_file')
@@ -281,18 +283,18 @@ describe('vim.secure', function()
         { true, full_path },
         exec_lua([[return {vim.secure.trust({action='deny', path='test_file'})}]])
       )
-      local trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      local trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('! %s', full_path), vim.trim(trust))
 
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='allow', bufnr=0})}]]))
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq(string.format('%s %s', hash, full_path), vim.trim(trust))
 
       eq(
         { true, full_path },
         exec_lua([[return {vim.secure.trust({action='remove', path='test_file'})}]])
       )
-      trust = helpers.read_file(fn.stdpath('state') .. pathsep .. 'trust')
+      trust = read_file(stdpath('state') .. pathsep .. 'trust')
       eq('', vim.trim(trust))
     end)
 
diff --git a/test/functional/plugin/editorconfig_spec.lua b/test/functional/plugin/editorconfig_spec.lua
index 115c28fbf6..c8151d2005 100644
--- a/test/functional/plugin/editorconfig_spec.lua
+++ b/test/functional/plugin/editorconfig_spec.lua
@@ -9,6 +9,8 @@ local exec_lua = helpers.exec_lua
 
 local testdir = 'Xtest-editorconfig'
 
+--- @param name string
+--- @param expected table<string,any>
 local function test_case(name, expected)
   local filename = testdir .. pathsep .. name
   command('edit ' .. filename)
diff --git a/test/functional/plugin/lsp/helpers.lua b/test/functional/plugin/lsp/helpers.lua
index 97fa108500..376de66c51 100644
--- a/test/functional/plugin/lsp/helpers.lua
+++ b/test/functional/plugin/lsp/helpers.lua
@@ -128,6 +128,18 @@ local function fake_lsp_server_setup(test_name, timeout_ms, options, settings)
   )
 end
 
+--- @class test.lsp.Config
+--- @field test_name string
+--- @field timeout_ms? integer
+--- @field options? table
+--- @field settings? table
+---
+--- @field on_setup? fun()
+--- @field on_init? fun(client: vim.lsp.Client, ...)
+--- @field on_handler? fun(...)
+--- @field on_exit? fun(code: integer, signal: integer)
+
+--- @param config test.lsp.Config
 function M.test_rpc_server(config)
   if config.test_name then
     M.clear_notrace()
@@ -158,6 +170,7 @@ function M.test_rpc_server(config)
       end
     end,
   })
+  --- @type integer, integer
   local code, signal
   local function on_request(method, args)
     if method == 'init' then
diff --git a/test/functional/plugin/lsp_spec.lua b/test/functional/plugin/lsp_spec.lua
index d130c74aac..4437c4aeaa 100644
--- a/test/functional/plugin/lsp_spec.lua
+++ b/test/functional/plugin/lsp_spec.lua
@@ -17,8 +17,8 @@ local fn = helpers.fn
 local retry = helpers.retry
 local stop = helpers.stop
 local NIL = vim.NIL
-local read_file = require('test.helpers').read_file
-local write_file = require('test.helpers').write_file
+local read_file = helpers.read_file
+local write_file = helpers.write_file
 local is_ci = helpers.is_ci
 local api = helpers.api
 local is_os = helpers.is_os
@@ -279,7 +279,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'shutdown', client_id = 1 } },
         { NIL, {}, { method = 'finish', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_finish',
         on_init = function(_client)
@@ -310,7 +310,7 @@ describe('LSP', function()
     end)
 
     it('should fire autocommands on attach and detach', function()
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_init',
         on_setup = function()
@@ -347,7 +347,7 @@ describe('LSP', function()
     end)
 
     it('should set default options on attach', function()
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'set_defaults_all_capabilities',
         on_init = function(_client)
@@ -395,7 +395,7 @@ describe('LSP', function()
     end)
 
     it('should overwrite options set by ftplugins', function()
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'set_defaults_all_capabilities',
         on_init = function(_client)
@@ -435,7 +435,7 @@ describe('LSP', function()
     end)
 
     it('should not overwrite user-defined options', function()
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'set_defaults_all_capabilities',
         on_init = function(_client)
@@ -506,7 +506,7 @@ describe('LSP', function()
         },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'check_workspace_configuration',
         on_init = function(_client)
@@ -596,7 +596,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'shutdown', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'text_document_sync_save_bool',
         on_init = function(c)
@@ -690,7 +690,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'shutdown', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server({
         test_name = 'text_document_save_did_open',
         on_init = function(c)
@@ -730,7 +730,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'shutdown', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'text_document_sync_save_includeText',
         on_init = function(c)
@@ -857,7 +857,7 @@ describe('LSP', function()
       local expected_handlers = {
         { NIL, {}, { method = 'finish', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'check_forward_request_cancelled',
         on_init = function(_client)
@@ -883,7 +883,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { { code = -32801 }, NIL, { method = 'error_code_test', bufnr = 1, client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'check_forward_content_modified',
         on_init = function(_client)
@@ -913,7 +913,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'slow_request', bufnr = 1, client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'check_pending_request_tracked',
         on_init = function(_client)
@@ -947,7 +947,7 @@ describe('LSP', function()
       local expected_handlers = {
         { NIL, {}, { method = 'finish', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'check_cancel_request_tracked',
         on_init = function(_client)
@@ -980,7 +980,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'slow_request', bufnr = 1, client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'check_tracked_requests_cleared',
         on_init = function(_client)
@@ -1019,7 +1019,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'slow_request', bufnr = 1, client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'check_tracked_requests_cleared',
         on_init = function(_client)
@@ -1055,7 +1055,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'shutdown', client_id = 1 } },
         { NIL, {}, { method = 'finish', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_finish',
         on_init = function(_client)
@@ -1097,7 +1097,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open',
         on_setup = function()
@@ -1143,7 +1143,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open',
         on_setup = function()
@@ -1186,7 +1186,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open_and_change',
         on_setup = function()
@@ -1234,7 +1234,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open_and_change_noeol',
         on_setup = function()
@@ -1301,7 +1301,7 @@ describe('LSP', function()
         },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'inlay_hint',
         on_setup = function()
@@ -1348,7 +1348,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open_and_change_incremental',
         options = {
@@ -1399,7 +1399,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open_and_change_incremental',
         options = {
@@ -1453,7 +1453,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open_and_change_incremental_editing',
         on_setup = function()
@@ -1498,7 +1498,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open_and_change_multi',
         on_setup = function()
@@ -1549,7 +1549,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'basic_check_buffer_open_and_change_multi_and_close',
         on_setup = function()
@@ -1603,7 +1603,7 @@ describe('LSP', function()
         { NIL, {}, { method = 'finish', client_id = 1 } },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'invalid_header',
         on_setup = function() end,
@@ -1636,7 +1636,7 @@ describe('LSP', function()
         },
         { NIL, {}, { method = 'start', client_id = 1 } },
       }
-      local client
+      local client --- @type vim.lsp.Client
       test_rpc_server {
         test_name = 'decode_nil',
         on_setup = function()
@@ -1849,7 +1849,7 @@ describe('LSP', function()
 
     describe('cursor position', function()
       it("don't fix the cursor if the range contains the cursor", function()
-        fn.nvim_win_set_cursor(0, { 2, 6 })
+        api.nvim_win_set_cursor(0, { 2, 6 })
         local edits = {
           make_edit(1, 0, 1, 19, 'Second line of text'),
         }
@@ -1861,11 +1861,11 @@ describe('LSP', function()
           'Fourth line of text',
           'å å ɧ 汉语 ↥ 🤦 🦄',
         }, buf_lines(1))
-        eq({ 2, 6 }, fn.nvim_win_get_cursor(0))
+        eq({ 2, 6 }, api.nvim_win_get_cursor(0))
       end)
 
       it('fix the cursor to the valid col if the content was removed', function()
-        fn.nvim_win_set_cursor(0, { 2, 6 })
+        api.nvim_win_set_cursor(0, { 2, 6 })
         local edits = {
           make_edit(1, 0, 1, 6, ''),
           make_edit(1, 6, 1, 19, ''),
@@ -1878,11 +1878,11 @@ describe('LSP', function()
           'Fourth line of text',
           'å å ɧ 汉语 ↥ 🤦 🦄',
         }, buf_lines(1))
-        eq({ 2, 0 }, fn.nvim_win_get_cursor(0))
+        eq({ 2, 0 }, api.nvim_win_get_cursor(0))
       end)
 
       it('fix the cursor to the valid row if the content was removed', function()
-        fn.nvim_win_set_cursor(0, { 2, 6 })
+        api.nvim_win_set_cursor(0, { 2, 6 })
         local edits = {
           make_edit(1, 0, 1, 6, ''),
           make_edit(0, 18, 5, 0, ''),
@@ -1891,11 +1891,11 @@ describe('LSP', function()
         eq({
           'First line of text',
         }, buf_lines(1))
-        eq({ 1, 17 }, fn.nvim_win_get_cursor(0))
+        eq({ 1, 17 }, api.nvim_win_get_cursor(0))
       end)
 
       it('fix the cursor row', function()
-        fn.nvim_win_set_cursor(0, { 3, 0 })
+        api.nvim_win_set_cursor(0, { 3, 0 })
         local edits = {
           make_edit(1, 0, 2, 0, ''),
         }
@@ -1906,14 +1906,14 @@ describe('LSP', function()
           'Fourth line of text',
           'å å ɧ 汉语 ↥ 🤦 🦄',
         }, buf_lines(1))
-        eq({ 2, 0 }, fn.nvim_win_get_cursor(0))
+        eq({ 2, 0 }, api.nvim_win_get_cursor(0))
       end)
 
       it('fix the cursor col', function()
         -- append empty last line. See #22636
         exec_lua('vim.api.nvim_buf_set_lines(...)', 1, -1, -1, true, { '' })
 
-        fn.nvim_win_set_cursor(0, { 2, 11 })
+        api.nvim_win_set_cursor(0, { 2, 11 })
         local edits = {
           make_edit(1, 7, 1, 11, ''),
         }
@@ -1926,11 +1926,11 @@ describe('LSP', function()
           'å å ɧ 汉语 ↥ 🤦 🦄',
           '',
         }, buf_lines(1))
-        eq({ 2, 7 }, fn.nvim_win_get_cursor(0))
+        eq({ 2, 7 }, api.nvim_win_get_cursor(0))
       end)
 
       it('fix the cursor row and col', function()
-        fn.nvim_win_set_cursor(0, { 2, 12 })
+        api.nvim_win_set_cursor(0, { 2, 12 })
         local edits = {
           make_edit(0, 11, 1, 12, ''),
         }
@@ -1941,7 +1941,7 @@ describe('LSP', function()
           'Fourth line of text',
           'å å ɧ 汉语 ↥ 🤦 🦄',
         }, buf_lines(1))
-        eq({ 1, 11 }, fn.nvim_win_get_cursor(0))
+        eq({ 1, 11 }, api.nvim_win_get_cursor(0))
       end)
     end)
 
@@ -2017,7 +2017,7 @@ describe('LSP', function()
   end)
 
   describe('apply_text_document_edit', function()
-    local target_bufnr
+    local target_bufnr --- @type integer
     local text_document_edit = function(editVersion)
       return {
         edits = {
@@ -2693,6 +2693,7 @@ describe('LSP', function()
       eq(expected, actual)
     end)
   end)
+
   describe('lsp.util.symbols_to_items', function()
     describe('convert DocumentSymbol[] to items', function()
       it('DocumentSymbol has children', function()
@@ -2967,7 +2968,7 @@ describe('LSP', function()
   end)
 
   describe('lsp.util.jump_to_location', function()
-    local target_bufnr
+    local target_bufnr --- @type integer
 
     before_each(function()
       target_bufnr = exec_lua [[
@@ -3027,21 +3028,21 @@ describe('LSP', function()
     end)
 
     it('adds current position to jumplist before jumping', function()
-      fn.nvim_win_set_buf(0, target_bufnr)
-      local mark = fn.nvim_buf_get_mark(target_bufnr, "'")
+      api.nvim_win_set_buf(0, target_bufnr)
+      local mark = api.nvim_buf_get_mark(target_bufnr, "'")
       eq({ 1, 0 }, mark)
 
-      fn.nvim_win_set_cursor(0, { 2, 3 })
+      api.nvim_win_set_cursor(0, { 2, 3 })
       jump(location(0, 9, 0, 9))
 
-      mark = fn.nvim_buf_get_mark(target_bufnr, "'")
+      mark = api.nvim_buf_get_mark(target_bufnr, "'")
       eq({ 2, 3 }, mark)
     end)
   end)
 
   describe('lsp.util.show_document', function()
-    local target_bufnr
-    local target_bufnr2
+    local target_bufnr --- @type integer
+    local target_bufnr2 --- @type integer
 
     before_each(function()
       target_bufnr = exec_lua([[
@@ -3128,101 +3129,101 @@ describe('LSP', function()
     end)
 
     it('does not add current position to jumplist if not focus', function()
-      fn.nvim_win_set_buf(0, target_bufnr)
-      local mark = fn.nvim_buf_get_mark(target_bufnr, "'")
+      api.nvim_win_set_buf(0, target_bufnr)
+      local mark = api.nvim_buf_get_mark(target_bufnr, "'")
       eq({ 1, 0 }, mark)
 
-      fn.nvim_win_set_cursor(0, { 2, 3 })
+      api.nvim_win_set_cursor(0, { 2, 3 })
       show_document(location(0, 9, 0, 9), false, true)
       show_document(location(0, 9, 0, 9, true), false, true)
 
-      mark = fn.nvim_buf_get_mark(target_bufnr, "'")
+      mark = api.nvim_buf_get_mark(target_bufnr, "'")
       eq({ 1, 0 }, mark)
     end)
 
     it('does not change cursor position if not focus and not reuse_win', function()
-      fn.nvim_win_set_buf(0, target_bufnr)
-      local cursor = fn.nvim_win_get_cursor(0)
+      api.nvim_win_set_buf(0, target_bufnr)
+      local cursor = api.nvim_win_get_cursor(0)
 
       show_document(location(0, 9, 0, 9), false, false)
-      eq(cursor, fn.nvim_win_get_cursor(0))
+      eq(cursor, api.nvim_win_get_cursor(0))
     end)
 
     it('does not change window if not focus', function()
-      fn.nvim_win_set_buf(0, target_bufnr)
-      local win = fn.nvim_get_current_win()
+      api.nvim_win_set_buf(0, target_bufnr)
+      local win = api.nvim_get_current_win()
 
       -- same document/bufnr
       show_document(location(0, 9, 0, 9), false, true)
-      eq(win, fn.nvim_get_current_win())
+      eq(win, api.nvim_get_current_win())
 
       -- different document/bufnr, new window/split
       show_document(location(0, 9, 0, 9, true), false, true)
-      eq(2, #fn.nvim_list_wins())
-      eq(win, fn.nvim_get_current_win())
+      eq(2, #api.nvim_list_wins())
+      eq(win, api.nvim_get_current_win())
     end)
 
     it("respects 'reuse_win' parameter", function()
-      fn.nvim_win_set_buf(0, target_bufnr)
+      api.nvim_win_set_buf(0, target_bufnr)
 
       -- does not create a new window if the buffer is already open
       show_document(location(0, 9, 0, 9), false, true)
-      eq(1, #fn.nvim_list_wins())
+      eq(1, #api.nvim_list_wins())
 
       -- creates a new window even if the buffer is already open
       show_document(location(0, 9, 0, 9), false, false)
-      eq(2, #fn.nvim_list_wins())
+      eq(2, #api.nvim_list_wins())
     end)
 
     it('correctly sets the cursor of the split if range is given without focus', function()
-      fn.nvim_win_set_buf(0, target_bufnr)
+      api.nvim_win_set_buf(0, target_bufnr)
 
       show_document(location(0, 9, 0, 9, true), false, true)
 
-      local wins = fn.nvim_list_wins()
+      local wins = api.nvim_list_wins()
       eq(2, #wins)
       table.sort(wins)
 
-      eq({ 1, 0 }, fn.nvim_win_get_cursor(wins[1]))
-      eq({ 1, 9 }, fn.nvim_win_get_cursor(wins[2]))
+      eq({ 1, 0 }, api.nvim_win_get_cursor(wins[1]))
+      eq({ 1, 9 }, api.nvim_win_get_cursor(wins[2]))
     end)
 
     it('does not change cursor of the split if not range and not focus', function()
-      fn.nvim_win_set_buf(0, target_bufnr)
-      fn.nvim_win_set_cursor(0, { 2, 3 })
+      api.nvim_win_set_buf(0, target_bufnr)
+      api.nvim_win_set_cursor(0, { 2, 3 })
 
       exec_lua([[vim.cmd.new()]])
-      fn.nvim_win_set_buf(0, target_bufnr2)
-      fn.nvim_win_set_cursor(0, { 2, 3 })
+      api.nvim_win_set_buf(0, target_bufnr2)
+      api.nvim_win_set_cursor(0, { 2, 3 })
 
       show_document({ uri = 'file:///fake/uri2' }, false, true)
 
-      local wins = fn.nvim_list_wins()
+      local wins = api.nvim_list_wins()
       eq(2, #wins)
-      eq({ 2, 3 }, fn.nvim_win_get_cursor(wins[1]))
-      eq({ 2, 3 }, fn.nvim_win_get_cursor(wins[2]))
+      eq({ 2, 3 }, api.nvim_win_get_c