refactor: annotate deprecated functions, fix lua-ls warnings (#1723)

Author: pynappo

.github/workflows/luals-check.yml

@@ -27,7 +27,7 @@ jobs:
         mise_toml: |
           [tools]
           neovim = "${{ matrix.neovim }}"
-          lua-language-server = "latest"
+          lua-language-server = "3.13.6"
 
     - name: Run lua-language-server check
       continue-on-error: true

.luarc.json

@@ -1,6 +1,8 @@
 {
   "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
-  "diagnostics.libraryFiles": "Disable",
+  "diagnostics": {
+    "libraryFiles": "Disable"
+  },
   "runtime": {
     "version": "LuaJIT",
     "path": [

lua/neo-tree.lua

@@ -1,10 +1,11 @@
 local vim = vim
 local M = {}
 
--- DEPRECATED: to be removed in a future release, use this instead:
--- ```
--- require("neo-tree.command").execute({ action = "close" })
--- ```
+--- To be removed in a future release, use this instead:
+--- ```lua
+--- require("neo-tree.command").execute({ action = "close" })
+--- ```
+---@deprecated
 M.close_all = function()
   require("neo-tree.command").execute({ action = "close" })
 end

lua/neo-tree/command/parser.lua

@@ -1,4 +1,5 @@
 local utils = require("neo-tree.utils")
+local _compat = require("neo-tree.utils._compat")
 
 local M = {
   FLAG = "<FLAG>",
@@ -8,7 +9,7 @@ local M = {
 }
 
 M.setup = function(all_source_names)
-  local source_names = utils.table_copy(all_source_names)
+  local source_names = vim.deepcopy(all_source_names, _compat.noref())
   table.insert(source_names, "migrations")
 
   -- A special source referring to the last used source.
@@ -88,7 +89,7 @@ M.resolve_path = function(path, validate_type)
   local abs_path = vim.fn.fnamemodify(expanded, ":p")
   if validate_type then
     local stat = vim.loop.fs_stat(abs_path)
-    if stat.type ~= validate_type then
+    if stat and stat.type ~= validate_type then
       error("Invalid path: " .. path .. " is not a " .. validate_type)
     end
   end

lua/neo-tree/events/queue.lua

@@ -6,9 +6,12 @@ local event_queues = {}
 local event_definitions = {}
 local M = {}
 
+---@class neotree.Event.Handler.Result
+---@field handled boolean?
+
 ---@class neotree.Event.Handler
 ---@field event neotree.Event|string
----@field handler fun(...)
+---@field handler fun(table?):(neotree.Event.Handler.Result?)
 ---@field id string?
 
 local validate_event_handler = function(event_handler)

lua/neo-tree/git/ignored.lua

@@ -129,6 +129,7 @@ M.mark_ignored = function(state, items, callback)
 
     for folder, folder_items in pairs(folders) do
       local args = { "-C", folder, "check-ignore", "--stdin" }
+      ---@diagnostic disable-next-line: missing-fields
       local job = Job:new({
         command = "git",
         args = args,

lua/neo-tree/git/status.lua

@@ -49,6 +49,12 @@ local function get_priority_git_status_code(status, other_status)
   end
 end
 
+---@class neotree.Git.Context
+---@field status neotree.Git.Status
+
+---@class neotree.Git.Status
+---@field [string] string
+
 local parse_git_status_line = function(context, line)
   context.lines_parsed = context.lines_parsed + 1
   if type(line) ~= "string" then
@@ -114,13 +120,11 @@ local parse_git_status_line = function(context, line)
     end)
   end
 end
-
 ---Parse "git status" output for the current working directory.
 ---@base git ref base
 ---@exclude_directories boolean Whether to skip bubling up status to directories
 ---@path string Path to run the git status command in, defaults to cwd.
----@return table table Table with the path as key and the status as value.
----@return table, string|nil The git root for the specified path.
+---@return neotree.Git.Status, string? git_status the neotree.Git.Status of the given root
 M.status = function(base, exclude_directories, path)
   local git_root = git_utils.get_repository_root(path)
   if not utils.truthy(git_root) then
@@ -250,6 +254,7 @@ M.status_async = function(path, base, opts)
     end)
 
     utils.debounce(event_id, function()
+      ---@diagnostic disable-next-line: missing-fields
       local staged_job = Job:new({
         command = "git",
         args = { "-C", git_root, "diff", "--staged", "--name-status", base, "--" },
@@ -267,6 +272,7 @@ M.status_async = function(path, base, opts)
         end,
       })
 
+      ---@diagnostic disable-next-line: missing-fields
       local unstaged_job = Job:new({
         command = "git",
         args = { "-C", git_root, "diff", "--name-status" },
@@ -287,6 +293,7 @@ M.status_async = function(path, base, opts)
         end,
       })
 
+      ---@diagnostic disable-next-line: missing-fields
       local untracked_job = Job:new({
         command = "git",
         args = { "-C", git_root, "ls-files", "--exclude-standard", "--others" },
@@ -307,6 +314,7 @@ M.status_async = function(path, base, opts)
         end,
       })
 
+      ---@diagnostic disable-next-line: missing-fields
       Job:new({
         command = "git",
         args = {

lua/neo-tree/git/utils.lua

@@ -11,6 +11,7 @@ M.get_repository_root = function(path, callback)
     args = { "-C", path, "rev-parse", "--show-toplevel" }
   end
   if type(callback) == "function" then
+    ---@diagnostic disable-next-line: missing-fields
     Job:new({
       command = "git",
       args = args,
@@ -32,12 +33,12 @@ M.get_repository_root = function(path, callback)
       end,
     }):start()
   else
-    local ok, git_root = utils.execute_command({ "git", unpack(args) })
+    local ok, git_output = utils.execute_command({ "git", unpack(args) })
     if not ok then
-      log.trace("GIT ROOT ERROR ", git_root)
+      log.trace("GIT ROOT ERROR ", git_output)
       return nil
     end
-    git_root = git_root[1]
+    local git_root = git_output[1]
 
     if utils.is_windows then
       git_root = utils.windowize_path(git_root)

lua/neo-tree/setup/init.lua

@@ -248,6 +248,7 @@ M.buffer_enter_event = function()
     vim.schedule(function()
       -- try to delete the buffer, only because if it was new it would take
       -- on options from the neo-tree window that are undesirable.
+      ---@diagnostic disable-next-line: param-type-mismatch
       pcall(vim.cmd, "bdelete " .. bufname)
       local fake_state = {
         window = {

lua/neo-tree/sources/buffers/init.lua

@@ -81,7 +81,7 @@ M.buffers_changed = function()
 end
 
 ---Navigate to the given path.
----@param path string Path to navigate to. If empty, will navigate to the cwd.
+---@param path string? Path to navigate to. If empty, will navigate to the cwd.
 M.navigate = function(state, path, path_to_reveal, callback, async)
   state.dirty = false
   local path_changed = false