begin using emmylua_ls

Author: lewis6991

.luarc.json

@@ -5,9 +5,8 @@
   },
   "workspace": {
     "library": [
-      "runtime/lua",
       "${3rd}/busted/library",
-      "${3rd}/luv/library"
+      "luv"
     ],
     "ignoreDir": [
       "test",

Makefile

@@ -182,3 +182,10 @@ appimage-%:
 	bash scripts/genappimage.sh $*
 
 .PHONY: test clean distclean nvim libnvim cmake deps install appimage checkprefix benchmark $(FORMAT) $(LINT) $(TEST)
+
+.PHONY: emmylua-check
+emmylua-check: luv
+	emmylua_check --config=$(PWD)/.luarc.json runtime/lua
+
+luv:
+	git clone https://github.com/LuaCATS/luv

runtime/lua/vim/lsp/buf.lua

@@ -177,7 +177,7 @@ local function get_locations(method, opts)
   ---@type vim.quickfix.entry[]
   local all_items = {}
 
-  ---@param result nil|lsp.Location|lsp.Location[]
+  ---@param result lsp.Location|lsp.Location[]?
   ---@param client vim.lsp.Client
   local function on_response(_, result, client)
     local locations = {}
@@ -315,7 +315,7 @@ local function process_signature_help_results(results)
       )
       api.nvim_command('redraw')
     else
-      local result = r.result --- @type lsp.SignatureHelp
+      local result = r.result
       if result and result.signatures and result.signatures[1] then
         for _, sig in ipairs(result.signatures) do
           sig.activeParameter = sig.activeParameter or result.activeParameter

runtime/lua/vim/lsp/client.lua

@@ -175,7 +175,7 @@ local validate = vim.validate
 ---
 --- Response from the server sent on `initialize` describing the server's
 --- capabilities.
---- @field server_capabilities lsp.ServerCapabilities?
+--- @field server_capabilities lsp.ServerCapabilities
 ---
 --- Response from the server sent on `initialize` describing information about
 --- the server.
@@ -229,13 +229,13 @@ local validate = vim.validate
 --- @field private _before_init_cb? vim.lsp.client.before_init_cb
 --- @field private _on_attach_cbs vim.lsp.client.on_attach_cb[]
 --- @field private _on_init_cbs vim.lsp.client.on_init_cb[]
---- @field private _on_exit_cbs vim.lsp.client.on_exit_cb[]
+--- @field package _on_exit_cbs vim.lsp.client.on_exit_cb[]
 --- @field private _on_error_cb? fun(code: integer, err: string)
 local Client = {}
 Client.__index = Client
 
 --- @param obj table<string,any>
---- @param cls table<string,function>
+--- @param cls table<string,function?>
 --- @param name string
 local function method_wrapper(obj, cls, name)
   local meth = assert(cls[name])
@@ -339,7 +339,7 @@ local function validate_config(config)
   )
 end
 
---- @param trace string
+--- @param trace string?
 --- @return 'off'|'messages'|'verbose'
 local function get_trace(trace)
   local valid_traces = {
@@ -445,16 +445,16 @@ function Client.create(config)
   --- @type vim.lsp.rpc.Dispatchers
   local dispatchers = {
     notification = function(...)
-      return self:_notification(...)
+      self:_notification(...)
     end,
     server_request = function(...)
       return self:_server_request(...)
     end,
     on_error = function(...)
-      return self:_on_error(...)
+      self:_on_error(...)
     end,
     on_exit = function(...)
-      return self:_on_exit(...)
+      self:_on_exit(...)
     end,
   }
 
@@ -602,7 +602,7 @@ end
 
 --- @private
 --- @param id integer
---- @param req_type 'pending'|'complete'|'cancel'|
+--- @param req_type 'pending'|'complete'|'cancel'
 --- @param bufnr? integer (only required for req_type='pending')
 --- @param method? string (only required for req_type='pending')
 function Client:_process_request(id, req_type, bufnr, method)
@@ -838,7 +838,7 @@ end
 --- @param registrations lsp.Registration[]
 function Client:_register_dynamic(registrations)
   -- remove duplicates
-  self:_unregister_dynamic(registrations)
+  self:_unregister_dynamic(registrations --[[@as lsp.Unregistration[] ]])
   for _, reg in ipairs(registrations) do
     local method = reg.method
     if not self.registrations[method] then

runtime/lua/vim/lsp/completion.lua

@@ -38,7 +38,7 @@ local lsp = vim.lsp
 local protocol = lsp.protocol
 local ms = protocol.Methods
 
-local rtt_ms = 50
+local rtt_ms = 50.0
 local ns_to_ms = 0.000001
 
 --- @alias vim.lsp.CompletionResult lsp.CompletionList | lsp.CompletionItem[]
@@ -110,7 +110,7 @@ end
 local function exp_avg(window, warmup)
   local count = 0
   local sum = 0
-  local value = 0
+  local value = 0.0
 
   return function(sample)
     if count < warmup then
@@ -384,7 +384,7 @@ local function adjust_start_col(lnum, line, items, encoding)
   end
 end
 
---- @private
+--- @package
 --- @param line string line content
 --- @param lnum integer 0-indexed line number
 --- @param cursor_col integer

runtime/lua/vim/lsp/semantic_tokens.lua

@@ -88,6 +88,7 @@ local function modifiers_from_number(x, modifiers_table)
   return modifiers
 end
 
+--- @async
 --- Converts a raw token list to a list of highlight ranges used by the on_win callback
 ---
 ---@param data integer[]
@@ -159,7 +160,7 @@ end
 
 --- Construct a new STHighlighter for the buffer
 ---
----@private
+---@package
 ---@param bufnr integer
 ---@return STHighlighter
 function STHighlighter.new(bufnr)
@@ -325,7 +326,7 @@ end
 ---
 --- Finally, a redraw command is issued to force nvim to redraw the screen to
 --- pick up changed highlight tokens.
----
+---@async
 ---@param response lsp.SemanticTokens|lsp.SemanticTokensDelta
 ---@private
 function STHighlighter:process_response(response, client, version)

runtime/lua/vim/lsp/util.lua

@@ -2200,7 +2200,6 @@ end
 ---@field only_visible? boolean Whether to only refresh for the visible regions of the buffer (default: false)
 ---@field client_id? integer Client ID to refresh (default: all clients)
 
----@private
 --- Request updated LSP information for a buffer.
 ---
 ---@param method string LSP method to call