ci: use lux for type checking

Author: Marc Jakobi

.github/workflows/tests.yml

@@ -39,9 +39,9 @@ jobs:
         run: |
           lx --nvim test
 
-      # TODO: Not stable in Lux yet.
-      # For now, we use Nix for type checking
-      # - name: Type checks
-      #   run: |
-      #     lx --nvim check
+      - name: Type checks
+        run: |
+          lx --nvim check --warnings-as-errors
+        env:
+          VIMRUNTIME: /home/runner/nvim-stable/share/nvim/runtime
 

.luarc.json

@@ -1,19 +1,30 @@
 {
+  "diagnostics": {
+    "enable": true,
+    "disable": [
+      "annotation-usage-error"
+    ]
+  },
   "workspace": {
     "library": [
       "$VIMRUNTIME",
       ".lux/5.1/test_dependencies/5.1/01a3c364614bddff7370223a5a9c4580f8e62d144384148444c518ec5367a59b-mediator_lua@1.1.2-0/src",
       ".lux/5.1/test_dependencies/5.1/287e827f4a088d41bba04af5f61a13614346c16fe8150eb7c4246e67d6fd163e-lua-term@0.8-1/src",
       ".lux/5.1/test_dependencies/5.1/316ac0b30e04e86a253d64886f3b110bd0508267474e6b58a3b973bd6857dbf4-penlight@1.14.0-3/src",
+      ".lux/5.1/test_dependencies/5.1/36c63cd0c043eb0fbc7d5ecd75907926b7136414cef7703dcd5784a61e6a728e-nvim-dap@0.10.0-1/src",
       ".lux/5.1/test_dependencies/5.1/455cd98d50c6191a9685cffcda4ce783efbb957934625e134c39f43bd5df6818-luassert@1.9.0-1/src",
       ".lux/5.1/test_dependencies/5.1/47b12edcdc032232157ace97bddf34bddd17f6f458095885e62bbd602ad9e9ec-luasystem@0.6.3-1/src",
       ".lux/5.1/test_dependencies/5.1/4e9592a499c9ced4f8ce366db9db7d9c0dd1424ea8d4c8c16c1550ea3a61a696-say@1.4.1-3/src",
       ".lux/5.1/test_dependencies/5.1/56b98be57b1a97b869fd8ded0d2c0b9ce0b6b052e2d5abf84d060748617b2c90-busted@2.2.0-1/src",
       ".lux/5.1/test_dependencies/5.1/6ce29c2c535c40246c386c056f24689344cddb56ec397473931431e6b67694d2-say@1.4.1-3/src",
       ".lux/5.1/test_dependencies/5.1/832fd9862ce671c0c9777855d4c8b19f9ad9c2679fb5466c3a183785a51b76b0-luafilesystem@1.8.0-1/src",
       ".lux/5.1/test_dependencies/5.1/a6c5176043cb3de56336b7de119443dbb3d9e024be1d50e06289ad4b4959a2da-lua_cliargs@3.0.2-1/src",
+      ".lux/5.1/test_dependencies/5.1/acdfde00d122aac481c18c906d483478bb536741beb025becc11782a075d125b-luassert@1.9.0-1/src",
+      ".lux/5.1/test_dependencies/5.1/b54df892b93931d9062f7bb8887a2ae7e6ce116e50d9aca0cf690256d7ac05b6-neotest@5.13.1-1/src",
       ".lux/5.1/test_dependencies/5.1/d85464dc58c62460a1ecb14e6ac773ae615a66a8224b26ceb25d954c6b05ca74-nlua@0.3.2-1/src",
-      ".lux/5.1/test_dependencies/5.1/e4f17b9e67313bbd5e90f425672fc8998dd0bfa43335f7c57ed2de7a799e07a6-dkjson@2.8-1/src"
+      ".lux/5.1/test_dependencies/5.1/de206edd51dbfc1bbe56869d6729cf4a6e6e70e7b2e107093c0f6520c142d79b-nvim-nio@1.10.1-1/src",
+      ".lux/5.1/test_dependencies/5.1/e4f17b9e67313bbd5e90f425672fc8998dd0bfa43335f7c57ed2de7a799e07a6-dkjson@2.8-1/src",
+      ".lux/5.1/test_dependencies/5.1/e6419c49ea30f1be0576a4def3982181470d4f3961a28360a17aa9396db68ff2-plenary.nvim@scm-1/src"
     ]
   }
 }

flake.nix

@@ -148,7 +148,8 @@
             pkgs.statix
             pkgs.nixd
             alejandra
-            lua-language-server
+            pkgs.emmylua-ls
+            # lua-language-server
             stylua
             editorconfig-checker
             markdownlint-cli

lua/rustaceanvim/cargo.lua

@@ -47,10 +47,10 @@ local function get_cargo_metadata(path, callback)
     end)
   else
     local sc = vim
-      .system(cmd, {
-        cwd = vim.uv.fs_stat(path) and path or cargo_crate_dir or vim.fn.getcwd(),
-      })
-      :wait()
+        .system(cmd, {
+          cwd = vim.uv.fs_stat(path) and path or cargo_crate_dir or vim.fn.getcwd(),
+        })
+        :wait()
     return on_exit(sc)
   end
 end
@@ -74,11 +74,11 @@ local function default_get_root_dir(file_name, callback)
   ---@return string | nil root_dir
   local function root_dir(cargo_crate_dir, cargo_metadata)
     return cargo_metadata and cargo_metadata.workspace_root
-      or cargo_crate_dir
-      or vim.fs.dirname(vim.fs.find({ 'rust-project.json' }, {
-        upward = true,
-        path = path,
-      })[1])
+        or cargo_crate_dir
+        or vim.fs.dirname(vim.fs.find({ 'rust-project.json' }, {
+          upward = true,
+          path = path,
+        })[1])
   end
   if callback then
     get_cargo_metadata(path, function(cargo_crate_dir, cargo_metadata)
@@ -107,7 +107,8 @@ local function get_mb_active_client_root(file_name)
     item = os.normalize_path_on_windows(item)
     if file_name:sub(1, #item) == item then
       local clients = rust_analyzer.get_active_rustaceanvim_clients()
-      return clients and #clients > 0 and clients[#clients].config.root_dir or nil
+      local client = clients[#clients]
+      return client and client.config.root_dir or nil
     end
   end
 end

lua/rustaceanvim/commands/diagnostic.lua

@@ -85,14 +85,15 @@ function M.explain_error(cycle_diagnostic)
   end
 
   local diagnostics = vim
-    .iter(vim.diagnostic.get(0, {}))
-    ---@param diagnostic vim.Diagnostic
-    :filter(function(diagnostic)
-      return diagnostic.code ~= nil
-        and diagnostic.source == 'rustc'
-        and diagnostic.severity == vim.diagnostic.severity.ERROR
-    end)
-    :totable()
+      .iter(vim.diagnostic.get(0, {}))
+      :filter(
+      ---@param diagnostic vim.Diagnostic
+        function(diagnostic)
+          return diagnostic.code ~= nil
+              and diagnostic.source == 'rustc'
+              and diagnostic.severity == vim.diagnostic.severity.ERROR
+        end)
+      :totable()
   if #diagnostics == 0 then
     vim.notify('No explainable errors found.', vim.log.levels.INFO)
     return
@@ -185,15 +186,15 @@ function M.explain_error_current_line()
 
   -- get matching diagnostics from current line
   local diagnostics = vim
-    .iter(vim.diagnostic.get(0, {
-      lnum = cursor_position[1] - 1,
-    }))
-    :filter(function(diagnostic)
-      return diagnostic.code ~= nil
-        and diagnostic.source == 'rustc'
-        and diagnostic.severity == vim.diagnostic.severity.ERROR
-    end)
-    :totable()
+      .iter(vim.diagnostic.get(0, {
+        lnum = cursor_position[1] - 1,
+      }))
+      :filter(function(diagnostic)
+        return diagnostic.code ~= nil
+            and diagnostic.source == 'rustc'
+            and diagnostic.severity == vim.diagnostic.severity.ERROR
+      end)
+      :totable()
 
   -- no matching diagnostics on current line
   if #diagnostics == 0 then
@@ -246,7 +247,7 @@ end
 local function render_ansi_code_diagnostic(rendered_diagnostic)
   -- adopted from https://stackoverflow.com/questions/48948630/lua-ansi-escapes-pattern
   local lines =
-    vim.split(rendered_diagnostic:gsub('[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]', ''), '\n', { trimempty = true })
+      vim.split(rendered_diagnostic:gsub('[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]', ''), '\n', { trimempty = true })
   local float_preview_lines = vim.deepcopy(lines)
   table.insert(float_preview_lines, 1, '---')
   table.insert(float_preview_lines, 1, '1. Open in split')
@@ -298,12 +299,12 @@ local function render_ansi_code_diagnostic(rendered_diagnostic)
       vim.api.nvim_feedkeys(
         vim.api.nvim_replace_termcodes(
           '<cmd>lua vim.api.nvim_set_current_win('
-            .. winnr
-            .. ')<CR>'
-            .. [[<c-\><c-n>]]
-            .. '<cmd>lua vim.api.nvim_win_set_cursor('
-            .. winnr
-            .. ',{1,0})<CR>',
+          .. winnr
+          .. ')<CR>'
+          .. [[<c-\><c-n>]]
+          .. '<cmd>lua vim.api.nvim_win_set_cursor('
+          .. winnr
+          .. ',{1,0})<CR>',
           true,
           false,
           true
@@ -318,12 +319,13 @@ end
 ---@param cycle_diagnostic (fun(opts?: vim.diagnostic.JumpOpts): vim.Diagnostic?)
 function M.render_diagnostic(cycle_diagnostic)
   local diagnostics = vim
-    .iter(vim.diagnostic.get(0, {}))
-    ---@param diagnostic vim.Diagnostic
-    :filter(function(diagnostic)
-      return get_rendered_diagnostic(diagnostic) ~= nil
-    end)
-    :totable()
+      .iter(vim.diagnostic.get(0, {}))
+      :filter(
+      ---@param diagnostic vim.Diagnostic
+        function(diagnostic)
+          return get_rendered_diagnostic(diagnostic) ~= nil
+        end)
+      :totable()
   if #diagnostics == 0 then
     vim.notify('No renderable diagnostics found.', vim.log.levels.INFO)
     return
@@ -401,12 +403,13 @@ function M.render_diagnostic_current_line()
   -- get rendered diagnostics from current line
   ---@type string[]
   local rendered_diagnostics = vim
-    .iter(get_diagnostics_current_line())
-    ---@param diagnostic vim.Diagnostic
-    :map(function(diagnostic)
-      return get_rendered_diagnostic(diagnostic)
-    end)
-    :totable()
+      .iter(get_diagnostics_current_line())
+      :map(
+      ---@param diagnostic vim.Diagnostic
+        function(diagnostic)
+          return get_rendered_diagnostic(diagnostic)
+        end)
+      :totable()
 
   -- if no renderable diagnostics on current line
   if #rendered_diagnostics == 0 then
@@ -430,17 +433,18 @@ function M.related_diagnostics()
   end
   ---@type lsp.Location[]
   local locations = vim
-    .iter(get_diagnostics_at_cursor())
-    ---@param diagnostic vim.Diagnostic
-    :map(function(diagnostic)
-      return vim.tbl_get(diagnostic, 'user_data', 'lsp', 'relatedInformation')
-    end)
-    :flatten()
-    ---@param related_info rustaceanvim.diagnostic.RelatedInfo
-    :map(function(related_info)
-      return related_info.location
-    end)
-    :totable()
+      .iter(get_diagnostics_at_cursor())
+      :map(
+      ---@param diagnostic vim.Diagnostic
+        function(diagnostic)
+          return vim.tbl_get(diagnostic, 'user_data', 'lsp', 'relatedInformation')
+        end)
+      :flatten()
+      ---@param related_info rustaceanvim.diagnostic.RelatedInfo
+      :map(function(related_info)
+        return related_info.location
+      end)
+      :totable()
   if #locations == 0 then
     vim.notify('No related diagnostics found.', vim.log.levels.INFO)
     return

lua/rustaceanvim/commands/external_docs.lua

@@ -2,14 +2,14 @@ local M = {}
 
 function M.open_external_docs()
   local ra = require('rustaceanvim.rust_analyzer')
-  local clients = ra.get_active_rustaceanvim_clients(0)
-  if #clients == 0 then
+  local client = ra.find_active_rustaceanvim_client(0)
+  if not client then
     return
   end
   ra.buf_request(
     0,
     'experimental/externalDocs',
-    vim.lsp.util.make_position_params(0, clients[1].offset_encoding or 'utf-8'),
+    vim.lsp.util.make_position_params(0, client.offset_encoding or 'utf-8'),
     function(_, response)
       local url
       if response['local'] and vim.uv.fs_stat(vim.uri_to_fname(response['local'])) then

lua/rustaceanvim/commands/hover_range.lua

@@ -56,8 +56,11 @@ local function get_visual_selected_range()
   return make_lsp_position(row1, math.min(col1, col2), row1, math.max(col1, col2))
 end
 
----@type lsp.Handler
-local function handler(_, result, _)
+---@param _err lsp.ResponseError?
+---@param result unknown
+---@param _context lsp.HandlerContext
+---@diagnostic disable-next-line: unused-local
+local function handler(_err, result, _context)
   if not (result and result.contents) then
     return
   end

lua/rustaceanvim/config/check.lua

@@ -7,10 +7,10 @@ local M = {}
 ---@param name string Argument name
 ---@param value unknown Argument value
 ---@param validator vim.validate.Validator
----   - (`string|string[]`): Any value that can be returned from |lua-type()| in addition to
+---   * (`string|string[]`): Any value that can be returned from |lua-type()| in addition to
 ---     `'callable'`: `'boolean'`, `'callable'`, `'function'`, `'nil'`, `'number'`, `'string'`, `'table'`,
 ---     `'thread'`, `'userdata'`.
----   - (`fun(val:any): boolean, string?`) A function that returns a boolean and an optional
+---   * (`fun(val:any): boolean, string?`) A function that returns a boolean and an optional
 ---     string message.
 ---@param optional? boolean Argument is optional (may be omitted)
 ---@param message? string message when validation fails

lua/rustaceanvim/rust_analyzer.lua

@@ -48,6 +48,13 @@ M.get_active_rustaceanvim_clients = function(bufnr, filter)
   return clients
 end
 
+---@param bufnr number | nil 0 for the current buffer, `nil` for no buffer filter
+---@param filter? rustaceanvim.lsp.get_clients.Filter
+---@return vim.lsp.Client | nil
+M.find_active_rustaceanvim_client = function(bufnr, filter)
+  return M.get_active_rustaceanvim_clients(bufnr, filter)[1]
+end
+
 ---@param method string LSP method name
 ---@param params table|nil Parameters to send to the server
 ---@param handler? lsp.Handler See |lsp-handler|