refactor(log): add types, improve perf, more level configuration (#1874)

Author: pynappo

lua/neo-tree/collections.lua

@@ -98,11 +98,11 @@ function Queue:for_each(func)
       elseif type(result) == "table" then
         if result.handled == true then
           log.trace(
-            "Handler ",
+            "Handler",
             node.value.id,
-            " for "
-              .. node.value.event
-              .. " returned handled = true, skipping the rest of the queue."
+            "for",
+            node.value.event,
+            "was handled, skipping the rest of the queue."
           )
           return result
         end

lua/neo-tree/defaults.lua

@@ -31,8 +31,17 @@ local config = {
   hide_root_node = false, -- Hide the root node.
   retain_hidden_root_indent = false, -- IF the root node is hidden, keep the indentation anyhow.
                                      -- This is needed if you use expanders because they render in the indent.
-  log_level = "info", -- "trace", "debug", "info", "warn", "error", "fatal"
-  log_to_file = false, -- true, false, "/path/to/file.log", use ':lua require("neo-tree").show_logs()' to show the file
+  -- The minimum level of log statements that should be logged to the log file.
+  log_level = vim.log.levels.INFO, -- or other vim.log.levels (up to .ERROR), or "trace", "debug", "info", "warn", "error", "fatal"
+  -- For usabiliity, the minimum console log level = max(log_level, INFO) unless set explicitly using a table:
+  -- log_level = {
+  --   file = vim.log.levels.INFO,
+  --   console = vim.log.levels.INFO,
+  -- },
+
+  -- true, false, "/path/to/file.log", use ':lua require("neo-tree").show_logs()' to show the file.
+  -- Default location is `vim.fn.stdpath("data") .. "/" .. "neo-tree.nvim.log"`
+  log_to_file = false,
   open_files_in_last_window = true, -- false = open files in top left window
   open_files_do_not_replace_types = { "terminal", "Trouble", "qf", "edgy" }, -- when opening files, do not use windows containing these filetypes or buftypes
   open_files_using_relative_paths = false,

lua/neo-tree/events/init.lua

@@ -67,7 +67,7 @@ end
 ---@param seed_fn function?
 ---@param nested boolean?
 M.define_autocmd_event = function(event_name, autocmds, debounce_frequency, seed_fn, nested)
-  log.debug("Defining autocmd event: %s", event_name)
+  log.debug("Defining autocmd event:", event_name)
   local augroup_name = "NeoTreeEvent_" .. event_name
   q.define_event(event_name, {
     setup = function()
@@ -91,7 +91,7 @@ M.define_autocmd_event = function(event_name, autocmds, debounce_frequency, seed
     end,
     seed = seed_fn,
     teardown = function()
-      log.trace("Teardown autocmds for ", event_name)
+      log.trace("Teardown autocmds for", event_name)
       vim.api.nvim_create_augroup(augroup_name, { clear = true })
     end,
     debounce_frequency = debounce_frequency,

lua/neo-tree/events/queue.lua

@@ -58,7 +58,7 @@ M.destroy_event = function(event_name)
   if existing.setup_was_run and type(existing.teardown) == "function" then
     local success, result = pcall(existing.teardown)
     if not success then
-      error("Error in teardown for " .. event_name .. ": " .. result)
+      log.error("Error in teardown for", event_name, ":", result)
     end
     existing.setup_was_run = false
   end
@@ -73,21 +73,21 @@ local fire_event_internal = function(event, args)
   if queue == nil then
     return nil
   end
-  --log.trace("Firing event: ", event, " with args: ", args)
 
   if queue:is_empty() then
     --log.trace("Event queue is empty")
     return nil
   end
+  log.trace("Firing event:", event, "with args:", args)
   local seed = utils.get_value(event_definitions, event .. ".seed")
   if seed ~= nil then
     local success, result = pcall(seed, args)
     if success and result then
-      log.trace("Seed for " .. event .. " returned: " .. tostring(result))
+      log.trace("Seed for", event, "returned: ", result)
     elseif success then
-      log.trace("Seed for " .. event .. " returned falsy, cancelling event")
+      log.trace("Seed for", event, "returned falsy, cancelling event")
     else
-      log.error("Error in seed function for " .. event .. ": " .. result)
+      log.error("Error in seed function for", event .. ": ", result)
     end
   end
 
@@ -97,9 +97,9 @@ local fire_event_internal = function(event, args)
       local success, result = pcall(event_handler.handler, args)
       local id = event_handler.id or event_handler
       if success then
-        log.trace("Handler ", id, " for " .. event .. " called successfully.")
+        log.trace("Handler", id, "for", event, "called successfully.")
       else
-        log.error(string.format("Error in event handler for event %s[%s]: %s", event, id, result))
+        log.at.error.format("Error in event handler for event %s[%s]: %s", event, id, result)
       end
       if event_handler.once then
         event_handler.cancelled = true
@@ -115,7 +115,6 @@ end
 M.fire_event = function(event, args)
   local freq = utils.get_value(event_definitions, event .. ".debounce_frequency", 0, true)
   local strategy = utils.get_value(event_definitions, event .. ".debounce_strategy", 0, true)
-  log.trace("Firing event: ", event, " with args: ", args)
   if freq > 0 then
     utils.debounce("EVENT_FIRED: " .. event, function()
       fire_event_internal(event, args or {})
@@ -131,21 +130,21 @@ M.subscribe = function(event_handler)
 
   local queue = event_queues[event_handler.event]
   if queue == nil then
-    log.debug("Creating queue for event: " .. event_handler.event)
+    log.debug("Creating queue for event:", event_handler.event)
     queue = Queue:new()
     local def = event_definitions[event_handler.event]
     if def and type(def.setup) == "function" then
       local success, result = pcall(def.setup)
       if success then
         def.setup_was_run = true
-        log.debug("Setup for event " .. event_handler.event .. " was run")
+        log.debug("Ran setup for event", event_handler.event)
       else
-        log.error("Error in setup for " .. event_handler.event .. ": " .. result)
+        log.error("Error in setup for", event_handler.event, ":", result)
       end
     end
     event_queues[event_handler.event] = queue
   end
-  log.debug("Adding event handler [", event_handler.id, "] for event: ", event_handler.event)
+  log.debug("Adding event handler [", event_handler.id, "] for event:", event_handler.event)
   queue:add(event_handler)
 end
 

lua/neo-tree/git/ignored.lua

@@ -145,7 +145,7 @@ M.mark_ignored = function(state, items, callback)
         enabled_recording = true,
         writer = folder_items,
         on_start = function()
-          log.trace("IGNORED: Running async git with args: ", args)
+          log.trace("IGNORED: Running async git with args:", args)
         end,
         on_exit = function(self, code, _)
           local results
@@ -170,7 +170,7 @@ M.mark_ignored = function(state, items, callback)
   else
     for folder, folder_items in pairs(folders) do
       local cmd = { "git", "-C", folder, "check-ignore", unpack(folder_items) }
-      log.trace("IGNORED: Running cmd: ", cmd)
+      log.trace("IGNORED: Running cmd:", cmd)
       local result = vim.fn.systemlist(cmd)
       if vim.v.shell_error == 128 then
         log.debug("Failed to load ignored files for", state.path, ":", result)

lua/neo-tree/git/status.lua

@@ -215,7 +215,7 @@ M.status_async = function(path, base, opts)
     if utils.truthy(git_root) then
       log.trace("git.status.status_async called")
     else
-      log.trace("status_async: not a git folder: ", path)
+      log.trace("status_async: not a git folder:", path)
       return false
     end
 

lua/neo-tree/git/utils.lua

@@ -18,7 +18,7 @@ M.get_repository_root = function(path, callback)
       enabled_recording = true,
       on_exit = function(self, code, _)
         if code ~= 0 then
-          log.trace("GIT ROOT ERROR ", self:stderr_result())
+          log.trace("GIT ROOT ERROR", self:stderr_result())
           callback(nil)
           return
         end
@@ -35,7 +35,7 @@ M.get_repository_root = function(path, callback)
   else
     local ok, git_output = utils.execute_command({ "git", unpack(args) })
     if not ok then
-      log.trace("GIT ROOT ERROR ", git_output)
+      log.trace("GIT ROOT ERROR", git_output)
       return nil
     end
     local git_root = git_output[1]