feat: allow sources to register custom stat_providers for nodes (#1121)

Author: cseickel

lua/neo-tree/ui/renderer.lua

@@ -270,6 +270,7 @@ create_nodes = function(source_items, state, level)
       skip_node = item.skip_node,
       is_empty_with_hidden_root = item.is_empty_with_hidden_root,
       stat = item.stat,
+      stat_provider = item.stat_provider,
       -- TODO: The below properties are not universal and should not be here.
       -- Maybe they should be moved to the "extra" field?
       is_link = item.is_link,

lua/neo-tree/utils/init.lua

@@ -324,18 +324,42 @@ M.get_inner_win_width = function(winid)
   end
 end
 
+local stat_providers = {
+  default = function (node)
+    return vim.loop.fs_stat(node.path)
+  end,
+}
+
 --- Gets the statics for a node in the file system. The `stat` object will be cached 
 --- for the lifetime of the node.
+---
 ---@param node table The Nui TreeNode node to get the stats for.
----@return table stat The stat object from libuv.
+---@return StatTable | table
+---
+---@class StatTime
+--- @field sec number
+---
+---@class StatTable
+--- @field birthtime StatTime
+--- @field mtime StatTime
+--- @field size number
 M.get_stat = function (node)
   if node.stat == nil then
-    local success, stat = pcall(vim.loop.fs_stat, node.path)
+    local provider = stat_providers[node.stat_provider or "default"]
+    local success, stat = pcall(provider, node)
     node.stat = success and stat or {}
   end
   return node.stat
 end
 
+---Register a function to provide stats for a node.
+---@param name string The name of the stat provider.
+---@param func function The function to call to get the stats.
+M.register_stat_provider = function (name, func)
+  stat_providers[name] = func
+  log.debug("Registered stat provider", name)
+end
+
 ---Handles null coalescing into a table at any depth.
 ---@param sourceObject table The table to get a vlue from.
 ---@param valuePath string The path to the value to get.