fix: type safety improvements

Author: Marc Jakobi

.github/workflows/tests.yml

@@ -43,5 +43,5 @@ jobs:
         run: |
           lx --nvim check --warnings-as-errors
         env:
-          VIMRUNTIME: /home/runner/nvim-stable/share/nvim/runtime
+          VIMRUNTIME: /home/runner/nvim-${{ matrix.nvim-version }}/share/nvim/runtime
 

.luarc.json

@@ -5,6 +5,9 @@
       "annotation-usage-error"
     ]
   },
+  "runtime": {
+    "version": "Lua 5.1"
+  },
   "workspace": {
     "library": [
       "$VIMRUNTIME",

flake.lock

@@ -13,15 +13,6 @@
 
     neovim-nightly-overlay.url = "github:nix-community/neovim-nightly-overlay";
 
-    gen-luarc = {
-      url = "github:mrcjkb/nix-gen-luarc-json";
-      inputs = {
-        nixpkgs.follows = "nixpkgs";
-        flake-parts.follows = "flake-parts";
-        git-hooks.follows = "git-hooks";
-      };
-    };
-
     vimcats = {
       url = "github:mrcjkb/vimcats";
       inputs = {
@@ -37,7 +28,6 @@
     nixpkgs,
     flake-parts,
     git-hooks,
-    gen-luarc,
     vimcats,
     ...
   }: let
@@ -65,53 +55,6 @@
 
         ci-overlay = import ./nix/ci-overlay.nix {inherit neovim-nightly;};
 
-        luarc-plugins = with pkgs.lua51Packages;
-          [
-            nvim-nio
-          ]
-          ++ (with pkgs.vimPlugins; [
-            neotest
-            nvim-dap
-          ]);
-
-        luarc-nightly = pkgs.mk-luarc {
-          nvim = neovim-nightly;
-          plugins = luarc-plugins;
-        };
-
-        luarc-stable = pkgs.mk-luarc {
-          nvim = pkgs.neovim-unwrapped;
-          plugins = luarc-plugins;
-          disabled-diagnostics = [
-            "undefined-doc-name"
-            "undefined-doc-class"
-            "redundant-parameter"
-            "invisible"
-          ];
-        };
-
-        type-check-nightly = git-hooks.lib.${system}.run {
-          src = self;
-          hooks = {
-            lua-ls = {
-              enable = true;
-              settings.configuration = luarc-nightly;
-            };
-          };
-        };
-
-        type-check-stable = git-hooks.lib.${system}.run {
-          src = self;
-          hooks = {
-            lua-ls = {
-              enable = true;
-              settings = {
-                configuration = luarc-stable;
-              };
-            };
-          };
-        };
-
         pre-commit-check = git-hooks.lib.${system}.run {
           src = self;
           hooks = {
@@ -143,13 +86,15 @@
           shellHook = ''
             ${pre-commit-check.shellHook}
           '';
+          env = {
+            EMMYLUALS_CONFIG = ".luarc.json";
+          };
           buildInputs = with git-hooks.packages.${system}; [
             pkgs.lux-cli
             pkgs.statix
             pkgs.nixd
-            alejandra
             pkgs.emmylua-ls
-            # lua-language-server
+            alejandra
             stylua
             editorconfig-checker
             markdownlint-cli
@@ -163,7 +108,6 @@
           inherit system;
           overlays = [
             ci-overlay
-            gen-luarc.overlays.default
             plugin-overlay
           ];
         };
@@ -186,10 +130,6 @@
 
         checks = {
           formatting = pre-commit-check;
-          inherit
-            type-check-stable
-            type-check-nightly
-            ;
         };
       };
       flake = {

flake.nix

@@ -11,8 +11,9 @@ store-success-output = true
 
 ---@return string path to nextest.toml file
 function M.nextest_config_path()
-  local cache_dir = vim.fs.joinpath(vim.fn.stdpath('cache'), 'rustaceanvim')
-  local config_path = vim.fs.joinpath(cache_dir, 'nextest_1.toml')
+  local nvim_cache_dir = vim.fn.stdpath('cache') ---@as string
+  local rustaceanvim_cache_dir = vim.fs.joinpath(nvim_cache_dir, 'rustaceanvim')
+  local config_path = vim.fs.joinpath(rustaceanvim_cache_dir, 'nextest_1.toml')
 
   -- Check if file already exists
   local stat = vim.uv.fs_stat(config_path)
@@ -21,7 +22,7 @@ function M.nextest_config_path()
   end
 
   -- Create cache directory if it doesn't exist
-  vim.fn.mkdir(cache_dir, 'p')
+  vim.fn.mkdir(rustaceanvim_cache_dir, 'p')
 
   -- Write the config file
   local file = io.open(config_path, 'w')

lua/rustaceanvim/cache.lua

@@ -6,9 +6,9 @@ local M = {}
 local cache = {
   ---@type rustaceanvim.RARunnableArgs | nil
   last_debuggable = nil,
-  ---@type rustaceanvim.RARunnablesChoice
+  ---@type rustaceanvim.RARunnablesChoice | nil
   last_runnable = nil,
-  ---@type rustaceanvim.RARunnablesChoice
+  ---@type rustaceanvim.RARunnablesChoice | nil
   last_testable = nil,
 }
 
@@ -54,8 +54,9 @@ end
 ---@param choice rustaceanvim.RARunnablesChoice
 ---@param executableArgsOverride? string[]
 local function override_executable_args_if_set(choice, executableArgsOverride)
-  if type(executableArgsOverride) == 'table' and #executableArgsOverride > 0 then
-    choice.runnables[choice.choice].args.executableArgs = executableArgsOverride
+  local runnable = choice.runnables[choice.choice]
+  if type(executableArgsOverride) == 'table' and #executableArgsOverride > 0 and runnable then
+    runnable.args.executableArgs = executableArgsOverride
   end
 end
 

lua/rustaceanvim/cached_commands.lua

@@ -28,7 +28,7 @@ local function get_cargo_metadata(path, callback)
       return callback and callback(cargo_crate_dir) or cargo_crate_dir
     end
     local ok, cargo_metadata_json = pcall(vim.fn.json_decode, sc.stdout)
-    if ok and cargo_metadata_json then
+    if ok and type(cargo_metadata_json) == 'table' then
       return callback and callback(cargo_crate_dir, cargo_metadata_json) or cargo_crate_dir, cargo_metadata_json
     else
       vim.notify(
@@ -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)