fix: reset faded hl cache on colorscheme change, allow disable char fading, fixes #311, fixes #291 (#312)

Author: cseickel

README.md

@@ -121,6 +121,9 @@ use {
         enable_git_status = true,
         enable_diagnostics = true,
         default_component_configs = {
+          container = {
+            enable_character_fade = true
+          },
           indent = {
             indent_size = 2,
             padding = 1, -- extra padding on left hand side

lua/neo-tree/defaults.lua

@@ -68,6 +68,9 @@ local config = {
   --  }
   --},
   default_component_configs = {
+    container = {
+      enable_character_fade = true
+    },
     indent = {
       indent_size = 2,
       padding = 1,

lua/neo-tree/setup/init.lua

@@ -227,12 +227,6 @@ local function merge_global_components_config(components, config)
       if name == "indent" then
         indent_exists = true
       end
-      if name == "container" then
-        for i, child in ipairs(component.content) do
-          component.content[i] = do_merge(child)
-        end
-        return component
-      end
       local merged = { name }
       local global_config = config.default_component_configs[name]
       if global_config then
@@ -243,6 +237,11 @@ local function merge_global_components_config(components, config)
       for k, v in pairs(component) do
         merged[k] = v
       end
+      if name == "container" then
+        for i, child in ipairs(component.content) do
+          merged.content[i] = do_merge(child)
+        end
+      end
       return merged
     else
       log.error("component name is the wrong type", component)
@@ -267,11 +266,51 @@ local function merge_global_components_config(components, config)
   return merged_components
 end
 
-M.merge_config = function(config, is_auto_config)
+local merge_renderers = function (default_config, source_default_config, user_config)
+  -- This can't be a deep copy/merge. If a renderer is specified in the target it completely
+  -- replaces the base renderer.
+
+  if source_default_config == nil then
+    -- first override the default config global renderer with the user's global renderers
+    for name, renderer in pairs(user_config.renderers or {}) do
+      log.debug("overriding global renderer for " .. name)
+      default_config.renderers[name] = renderer
+    end
+  else
+    -- then override the global renderers with the source specific renderers
+    source_default_config.renderers = source_default_config.renderers or {}
+    for name, renderer in pairs(default_config.renderers or {}) do
+      if source_default_config.renderers[name] == nil then
+        log.debug("overriding source renderer for " .. name)
+        local r = {}
+        -- Only copy components that exist in the target source.
+        -- This alllows us to specify global renderers that include components from all sources,
+        -- even if some of those components are not universal
+        for _, value in ipairs(renderer) do
+          if value[1] and source_default_config.components[value[1]] ~= nil then
+            table.insert(r, value)
+          end
+        end
+        source_default_config.renderers[name] = r
+      end
+    end
+
+    -- if user sets renderers, completely wipe the default ones
+    local source_name = source_default_config.name
+    for name, _ in pairs(source_default_config.renderers) do
+      local user = utils.get_value(user_config, source_name .. ".renderers." .. name)
+      if user then
+        source_default_config.renderers[name] = nil
+      end
+    end
+  end
+end
+
+M.merge_config = function(user_config, is_auto_config)
   local default_config = vim.deepcopy(defaults)
-  config = vim.deepcopy(config or {})
+  user_config = vim.deepcopy(user_config or {})
 
-  local migrations = require("neo-tree.setup.deprecations").migrate(config)
+  local migrations = require("neo-tree.setup.deprecations").migrate(user_config)
   if #migrations > 0 then
     -- defer to make sure it is the last message printed
     vim.defer_fn(function()
@@ -281,10 +320,10 @@ M.merge_config = function(config, is_auto_config)
     end, 50)
   end
 
-  if config.log_level ~= nil then
-    M.set_log_level(config.log_level)
+  if user_config.log_level ~= nil then
+    M.set_log_level(user_config.log_level)
   end
-  log.use_file(config.log_to_file, true)
+  log.use_file(user_config.log_to_file, true)
   log.debug("setup")
 
   events.clear_all_events()
@@ -296,8 +335,8 @@ M.merge_config = function(config, is_auto_config)
     handler = M.buffer_enter_event,
   })
 
-  if config.event_handlers ~= nil then
-    for _, handler in ipairs(config.event_handlers) do
+  if user_config.event_handlers ~= nil then
+    for _, handler in ipairs(user_config.event_handlers) do
       events.subscribe(handler)
     end
   end
@@ -306,6 +345,7 @@ M.merge_config = function(config, is_auto_config)
 
   -- setup the default values for all sources
   normalize_mappings(default_config)
+  merge_renderers(default_config, nil, user_config)
   for _, source_name in ipairs(sources) do
     local source_default_config = default_config[source_name]
     local mod_root = "neo-tree.sources." .. source_name
@@ -315,47 +355,29 @@ M.merge_config = function(config, is_auto_config)
 
     -- Make sure all the mappings are normalized so they will merge properly.
     normalize_mappings(source_default_config)
-    normalize_mappings(config[source_name])
+    normalize_mappings(user_config[source_name])
 
     local use_default_mappings = default_config.use_default_mappings
-    if type(config.use_default_mappings) ~= "nil" then
-      use_default_mappings = config.use_default_mappings
+    if type(user_config.use_default_mappings) ~= "nil" then
+      use_default_mappings = user_config.use_default_mappings
     end
     if use_default_mappings then
       -- merge the global config with the source specific config
       source_default_config.window = vim.tbl_deep_extend(
         "force",
         default_config.window or {},
         source_default_config.window or {},
-        config.window or {}
+        user_config.window or {}
       )
     else
-      source_default_config.window = config.window
-    end
-    source_default_config.renderers = source_default_config.renderers or {}
-    -- if source does not specify a renderer, use the global default
-    for name, renderer in pairs(default_config.renderers or {}) do
-      if source_default_config.renderers[name] == nil then
-        local r = {}
-        for _, value in ipairs(renderer) do
-          if value[1] and source_default_config.components[value[1]] ~= nil then
-            table.insert(r, value)
-          end
-        end
-        source_default_config.renderers[name] = r
-      end
-    end
-    -- if user sets renderers, completely wipe the default ones
-    for name, _ in pairs(source_default_config.renderers) do
-      local user = utils.get_value(config, source_name .. ".renderers." .. name)
-      if user then
-        source_default_config.renderers[name] = nil
-      end
+      source_default_config.window = user_config.window
     end
 
+    merge_renderers(default_config, source_default_config, user_config)
+
     --validate the window.position
     local pos_key = source_name .. ".window.position"
-    local position = utils.get_value(config, pos_key, "left", true)
+    local position = utils.get_value(user_config, pos_key, "left", true)
     local valid_positions = {
       left = true,
       right = true,
@@ -366,13 +388,13 @@ M.merge_config = function(config, is_auto_config)
     }
     if not valid_positions[position] then
       log.error("Invalid value for ", pos_key, ": ", position)
-      config[source_name].window.position = "left"
+      user_config[source_name].window.position = "left"
     end
   end
   --print(vim.inspect(default_config.filesystem))
 
   -- apply the users config
-  M.config = vim.tbl_deep_extend("force", default_config, config)
+  M.config = vim.tbl_deep_extend("force", default_config, user_config)
   if not M.config.enable_git_status then
     M.config.git_status_async = false
   end

lua/neo-tree/sources/common/container.lua

@@ -5,7 +5,7 @@ local log = require("neo-tree.log")
 
 local M = {}
 
-local calc_rendered_width = function (rendered_item)
+local calc_rendered_width = function(rendered_item)
   local width = 0
 
   for _, item in ipairs(rendered_item) do
@@ -48,7 +48,7 @@ local calc_container_width = function(config, node, state, context)
   return container_width
 end
 
-local render_content = function (config, node, state, context)
+local render_content = function(config, node, state, context)
   local max_width = 0
 
   local grouped_by_zindex = utils.group_by(config.content, "zindex")
@@ -75,7 +75,7 @@ end
 ---@param layer table The list of rendered components.
 ---@param skip_count number The number of characters to skip from the begining/left.
 ---@param max_length number The maximum number of characters to return.
-local truncate_layer_keep_left = function (layer, skip_count, max_length)
+local truncate_layer_keep_left = function(layer, skip_count, max_length)
   local result = {}
   local taken = 0
   local skipped = 0
@@ -109,7 +109,7 @@ end
 ---@param layer table The list of rendered components.
 ---@param skip_count number The number of characters to skip from the end/right.
 ---@param max_length number The maximum number of characters to return.
-local truncate_layer_keep_right = function (layer, skip_count, max_length)
+local truncate_layer_keep_right = function(layer, skip_count, max_length)
   local result = {}
   local taken = 0
   local skipped = 0
@@ -229,14 +229,18 @@ local merge_content = function(context)
       local width = calc_rendered_width(layer.left)
       if width > remaining_width then
         local truncated = truncate_layer_keep_left(layer.left, left_width, remaining_width)
-        try_fade_content(truncated, 3)
+        if context.enable_character_fade then
+          try_fade_content(truncated, 3)
+        end
         vim.list_extend(left, truncated)
         remaining_width = 0
       else
         remaining_width = remaining_width - width
-        local fade_chars = 3 - remaining_width
-        if fade_chars > 0 then
-          try_fade_content(layer.left, fade_chars)
+        if context.enable_character_fade then
+          local fade_chars = 3 - remaining_width
+          if fade_chars > 0 then
+            try_fade_content(layer.left, fade_chars)
+          end
         end
         vim.list_extend(left, layer.left)
         left_width = left_width + width
@@ -259,13 +263,14 @@ local merge_content = function(context)
   context.merged_content = result
 end
 
-M.render = function (config, node, state, available_width)
+M.render = function(config, node, state, available_width)
   local context = {
     max_width = 0,
     grouped_by_zindex = {},
     available_width = available_width,
     left_padding = config.left_padding,
     right_padding = config.right_padding,
+    enable_character_fade = config.enable_character_fade,
   }
 
   render_content(config, node, state, context)

lua/neo-tree/ui/highlights.lua

@@ -192,6 +192,9 @@ M.get_faded_highlight_group = function(hl_group_name, fade_percentage)
 end
 
 M.setup = function()
+  -- Reset this here in case of color scheme change
+  faded_highlight_group_cache = {}
+
   local normal_hl = create_highlight_group(M.NORMAL, { "Normal" })
   local normalnc_hl = create_highlight_group(M.NORMALNC, { "NormalNC", M.NORMAL })