chore: small cleanup of unused stuff and add some types

Author: ckipp01

lua/metals.lua

@@ -37,7 +37,7 @@ end
 
 M.analyze_stacktrace = function()
   local trace = fn.getreg("*")
-  if trace:len() > 0 then
+  if trace and trace:len() > 0 then
     execute_command({ command = "metals.analyze-stacktrace", arguments = { trace } })
   else
     log.warn_and_show("No text found in your register.")
@@ -126,28 +126,30 @@ end
 -- floating window.
 M.info = function()
   local config = conf.get_config_cache()
-  if not util.has_bins(conf.metals_bin()) and config.settings.metals.useGlobalExecutable then
+  if not util.has_bins(conf.metals_bin()) and config and config.settings.metals.useGlobalExecutable then
     log.error_and_show(messages.use_global_set_but_cant_find)
-  elseif not util.has_bins(conf.metals_bin()) and config.settings.metals.metalsBinaryPath then
+  elseif not util.has_bins(conf.metals_bin()) and config and config.settings.metals.metalsBinaryPath then
     log.error_and_show(messages.binary_path_set_but_cant_find)
   elseif not util.has_bins(conf.metals_bin()) then
     log.warn_and_show(messages.metals_not_installed)
   else
-    local metals_info = fn.system(conf.metals_bin() .. " --version")
-
     local output = {}
-    for s in metals_info:gmatch("[^\r\n]+") do
-      -- A little hacky but the version output is weird and we want to coerce
-      -- it to markdown, so we give the verstion line a # and then strip the
-      -- other lines of their #
-      if util.starts_with(s, "#") then
-        table.insert(output, s:sub(2))
-      else
-        table.insert(output, "# " .. s)
+
+    local metals_info = fn.system(conf.metals_bin() .. " --version")
+    if metals_info then
+      for s in metals_info:gmatch("[^\r\n]+") do
+        -- A little hacky but the version output is weird and we want to coerce
+        -- it to markdown, so we give the verstion line a # and then strip the
+        -- other lines of their #
+        if util.starts_with(s, "#") then
+          table.insert(output, s:sub(2))
+        else
+          table.insert(output, "# " .. s)
+        end
       end
     end
 
-    if config.settings.metals then
+    if config and config.settings.metals then
       table.insert(output, "")
       table.insert(output, "## Current settings")
       table.insert(output, "```json")
@@ -161,7 +163,7 @@ M.info = function()
     table.insert(output, string.format("  - nvim-metals log file: %s", log.nvim_metals_log))
     table.insert(output, string.format("  - nvim lsp log file: %s", lsp.get_log_path()))
     local loc_msg = "  - metals install location:"
-    if config.settings.metals.useGlobalExecutable then
+    if config and config.settings.metals.useGlobalExecutable then
       table.insert(output, string.format("%s %s", loc_msg, "Using metals executable on $PATH"))
     else
       table.insert(output, string.format("%s %s", loc_msg, conf.metals_bin()))
@@ -271,31 +273,35 @@ M.did_focus = function()
 end
 
 M.find_in_dependency_jars = function()
-  local function send_request(mask, query)
-    lsp.buf_request(util.find_metals_buffer(), "metals/findTextInDependencyJars", {
-      options = { include = mask },
-      query = { pattern = query },
-    })
-  end
+  local metals_buf = util.find_metals_buffer()
+
+  if metals_buf then
+    local function send_request(mask, query)
+      lsp.buf_request(metals_buf, "metals/findTextInDependencyJars", {
+        options = { include = mask },
+        query = { pattern = query },
+      })
+    end
+
+    local function get_query_and_send(mask)
+      vim.ui.input({
+        prompt = "Query: ",
+      }, function(query)
+        if query ~= nil then
+          send_request(mask, query)
+        end
+      end)
+    end
 
-  local function get_query_and_send(mask)
     vim.ui.input({
-      prompt = "Query: ",
-    }, function(query)
-      if query ~= nil then
-        send_request(mask, query)
+      prompt = "File mask: ",
+      default = ".conf",
+    }, function(mask)
+      if mask ~= nil then
+        get_query_and_send(mask)
       end
     end)
   end
-
-  vim.ui.input({
-    prompt = "File mask: ",
-    default = ".conf",
-  }, function(mask)
-    if mask ~= nil then
-      get_query_and_send(mask)
-    end
-  end)
 end
 
 M.organize_imports = function()

lua/metals/util.lua

@@ -15,11 +15,11 @@ M.has_bins = function(...)
   return true
 end
 
--- Checks to see if a user given table is defined. If so, merge it with a default.
--- If not, just return the default table. This function favors the userTable on merge.
--- @param defaultTable The default table to return or merge
--- @param userTable The user defined table to check if exists and then merge
--- @return a new table that is either the default or merged with the user one.
+--- Checks to see if a user given table is defined. If so, merge it with a default.
+--- If not, just return the default table. This function favors the userTable on merge.
+--- @param defaultTable table The default table to return or merge
+--- @param userTable table The user defined table to check if exists and then merge
+--- @return table that is either the default or merged with the user one.
 M.check_exists_and_merge = function(defaultTable, userTable)
   -- TODO should we add another check in here to ensure that a key that a user
   -- is trying to set actually exists in the default table?
@@ -30,21 +30,14 @@ M.check_exists_and_merge = function(defaultTable, userTable)
   end
 end
 
--- Location of any files or executables that nvim-metals will create on your system
+--- Location of any files or executables that nvim-metals will create on your system
+---@type string
 M.nvim_metals_cache_dir = Path.new(vim.fn.stdpath("cache"), "nvim-metals")
 
---- Strip the leading and trailing spaces of a string
---- @param s string the string you want to trim.
-M.full_trim = function(s)
-  return (s:gsub("^%s*(.-)%s*$", "%1"))
-end
-
---- Strip trailing whites and trailing empty lines
---- @param s string the string you want to trim.
-M.trim_end = function(s)
-  return string.gsub(s, "[ \t]+%f[\r\n%z]", "")
-end
-
+--- Given a delimter split a string into a table.
+---@param s string
+---@param delimiter string
+---@return table of split results
 M.split_on = function(s, delimiter)
   local result = {}
   local from = 1
@@ -105,6 +98,7 @@ end
 
 M.is_windows = vim.loop.os_uname().version:match("Windows")
 
+---@return integer|nil
 M.find_metals_buffer = function()
   local metals_buf = nil
   local bufs = api.nvim_list_bufs()