refactor(types): type annotate nearly everything (#1799)

Author: pynappo

Makefile

@@ -13,7 +13,7 @@ format:
 
 # Dependencies:
 
-DEPS := ./.dependencies/site/pack/vendor/start
+DEPS := ${CURDIR}/.dependencies/site/pack/vendor/start
 
 $(DEPS):
 	mkdir -p "$(DEPS)"
@@ -34,9 +34,9 @@ setup: $(DEPS)/nui.nvim $(DEPS)/nvim-web-devicons $(DEPS)/plenary.nvim
 clean:
 	rm -rf "$(DEPS)"
 
-CONFIGURATION = .luarc.json
+CONFIGURATION = ${CURDIR}/.luarc.json
 luals-check: setup
 	VIMRUNTIME="`nvim --clean --headless --cmd 'lua io.write(vim.env.VIMRUNTIME)' --cmd 'quit'`" lua-language-server --configpath=$(CONFIGURATION) --check=.
 
 emmylua-check: setup
-	VIMRUNTIME="`nvim --clean --headless --cmd 'lua io.write(vim.env.VIMRUNTIME)' --cmd 'quit'`" emmylua_check -c $(CONFIGURATION) .
+	VIMRUNTIME="`nvim --clean --headless --cmd 'lua io.write(vim.env.VIMRUNTIME)' --cmd 'quit'`" emmylua_check -c $(CONFIGURATION) -i ".dependencies/**" --  .

lua/neo-tree.lua

@@ -22,6 +22,8 @@ M.ensure_config = function()
   return M.config
 end
 
+---@param ignore_filetypes string[]?
+---@param ignore_winfixbuf boolean?
 M.get_prior_window = function(ignore_filetypes, ignore_winfixbuf)
   local utils = require("neo-tree.utils")
   ignore_filetypes = ignore_filetypes or {}
@@ -54,14 +56,18 @@ end
 
 M.paste_default_config = function()
   local utils = require("neo-tree.utils")
-  local base_path = debug.getinfo(utils.truthy).source:match("@(.*)/utils/init.lua$")
+  ---@type string
+  local base_path = assert(debug.getinfo(utils.truthy).source:match("@(.*)/utils/init.lua$"))
+  ---@type string
   local config_path = base_path .. utils.path_separator .. "defaults.lua"
+  ---@type string[]?
   local lines = vim.fn.readfile(config_path)
   if lines == nil then
     error("Could not read neo-tree.defaults")
   end
 
   -- read up to the end of the config, jut to omit the final return
+  ---@type string[]
   local config = {}
   for _, line in ipairs(lines) do
     table.insert(config, line)

lua/neo-tree/collections.lua

@@ -1,5 +1,10 @@
 local log = require("neo-tree.log")
 
+---@class neotree.collections.ListNode
+---@field prev neotree.collections.ListNode?
+---@field next neotree.collections.ListNode?
+---@field value any
+
 local Node = {}
 function Node:new(value)
   local props = { prev = nil, next = nil, value = value }
@@ -8,14 +13,21 @@ function Node:new(value)
   return props
 end
 
+---@class neotree.collections.LinkedList
+---@field head neotree.collections.ListNode?
+---@field tail neotree.collections.ListNode?
+---@field size integer
 local LinkedList = {}
+
+---@return neotree.collections.LinkedList
 function LinkedList:new()
   local props = { head = nil, tail = nil, size = 0 }
   setmetatable(props, self)
   self.__index = self
   return props
 end
 
+---@param node neotree.collections.ListNode
 function LinkedList:add_node(node)
   if self.head == nil then
     self.head = node
@@ -29,6 +41,7 @@ function LinkedList:add_node(node)
   return node
 end
 
+---@param node neotree.collections.ListNode
 function LinkedList:remove_node(node)
   if node.prev ~= nil then
     node.prev.next = node.next
@@ -49,7 +62,11 @@ function LinkedList:remove_node(node)
 end
 
 -- First in Last Out
+---@class neotree.collections.Queue
+---@field _list neotree.collections.LinkedList
 local Queue = {}
+
+---@return neotree.collections.Queue
 function Queue:new()
   local props = { _list = LinkedList:new() }
   setmetatable(props, self)
@@ -66,6 +83,7 @@ end
 ---Iterates over the entire list, running func(value) on each element.
 ---If func returns true, the element is removed from the list.
 ---@param func function The function to run on each element.
+---@return table? result
 function Queue:for_each(func)
   local node = self._list.head
   while node ~= nil do
@@ -91,6 +109,7 @@ function Queue:for_each(func)
       end
     end
     if not node_is_next then
+      ---@diagnostic disable-next-line: need-check-nil
       node = node.next
     end
   end

lua/neo-tree/command/completion.lua

@@ -5,6 +5,9 @@ local M = {
   show_key_value_completions = true,
 }
 
+---@param key_prefix string?
+---@param base_path string
+---@return string paths_string
 local get_path_completions = function(key_prefix, base_path)
   key_prefix = key_prefix or ""
   local completions = {}
@@ -29,6 +32,8 @@ local get_path_completions = function(key_prefix, base_path)
   return table.concat(completions, "\n")
 end
 
+---@param key_prefix string?
+---@return string references_string
 local get_ref_completions = function(key_prefix)
   key_prefix = key_prefix or ""
   local completions = { key_prefix .. "HEAD" }
@@ -46,6 +51,9 @@ local get_ref_completions = function(key_prefix)
   return table.concat(completions, "\n")
 end
 
+---@param argLead string
+---@param cmdLine string
+---@return string candidates_string
 M.complete_args = function(argLead, cmdLine)
   local candidates = {}
   local existing = utils.split(cmdLine, " ")
@@ -80,12 +88,12 @@ M.complete_args = function(argLead, cmdLine)
     -- continuation of a key=value pair
     local key = string.sub(argLead, 1, eq - 1)
     local value = string.sub(argLead, eq + 1)
-    local arg_type = parser.arg_type_lookup[key]
-    if arg_type == parser.PATH then
+    local arg_type = parser.argtype_lookup[key]
+    if arg_type == parser.argtypes.PATH then
       return get_path_completions(key .. "=", value)
-    elseif arg_type == parser.REF then
+    elseif arg_type == parser.argtypes.REF then
       return get_ref_completions(key .. "=")
-    elseif arg_type == parser.LIST then
+    elseif arg_type == parser.argtypes.LIST then
       local valid_values = parser.arguments[key].values
       if valid_values and not (parsed[key] and #parsed[key] > 0) then
         for _, vv in ipairs(valid_values) do
@@ -101,7 +109,7 @@ M.complete_args = function(argLead, cmdLine)
   for value, key in pairs(parser.reverse_lookup) do
     value = tostring(value)
     local key_already_used = false
-    if parser.arg_type_lookup[key] == parser.LIST then
+    if parser.argtype_lookup[key] == parser.argtypes.LIST then
       key_already_used = type(parsed[key]) ~= "nil"
     else
       key_already_used = type(parsed[value]) ~= "nil"

lua/neo-tree/command/init.lua

@@ -94,6 +94,7 @@ M.execute = function(args)
   end
 
   -- Now get the correct state
+  ---@type neotree.State
   local state
   local requested_position = args.position or nt.config[args.source].window.position
   if requested_position == "current" then