feat: add window.auto_expand_width option (related to #547) (#580)

Author: pysan3

lua/neo-tree/defaults.lua

@@ -287,6 +287,7 @@ local config = {
     position = "left", -- left, right, top, bottom, float, current
     width = 40, -- applies to left and right positions
     height = 15, -- applies to top and bottom positions
+    auto_expand_width = false, -- expand the window when file exceeds the window width. does not work with position = "float"
     popup = { -- settings that apply to float position only
       size = {
         height = "80%",
@@ -338,6 +339,7 @@ local config = {
       ["p"] = "paste_from_clipboard",
       ["c"] = "copy", -- takes text input for destination, also accepts the config.show_path option
       ["m"] = "move", -- takes text input for destination, also accepts the config.show_path option
+      ["e"] = "toggle_auto_expand_width",
       ["q"] = "close_window",
       ["?"] = "show_help",
       ["<"] = "prev_source",
@@ -483,7 +485,7 @@ local config = {
     window = {
       mappings = {
         ["<cr>"] = "toggle_node",
-        ["e"] = "example_command",
+        ["<C-e>"] = "example_command",
         ["d"] = "show_debug_info",
       },
     },

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

@@ -142,6 +142,23 @@ M.close_window = function(state)
   renderer.close(state)
 end
 
+M.toggle_auto_expand_width = function(state)
+  if state.window.position == "float" then
+    return
+  end
+  state.window.auto_expand_width = state.window.auto_expand_width == false
+  if not state.window.auto_expand_width then
+    if (state.window.last_user_width or state.window.width) >= vim.api.nvim_win_get_width(0) then
+      state.window.last_user_width = state.window.width
+    end
+    vim.api.nvim_win_set_width(0, state.window.last_user_width)
+    state.win_width = state.window.last_user_width
+    state.longest_width_exact = 0
+    log.trace(string.format("Collapse auto_expand_width."))
+  end
+  renderer.redraw(state)
+end
+
 local copy_node_to_clipboard = function(state, node)
   state.clipboard = state.clipboard or {}
   local existing = state.clipboard[node.id]

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

@@ -187,7 +187,8 @@ local merge_content = function(context)
   -- * Repeat until all layers have been merged.
   -- * Join the left and right tables together and return.
   --
-  local remaining_width = context.container_width
+  local huge_number = 2000
+  local remaining_width = context.auto_expand_width and huge_number or context.container_width
   local left, right = {}, {}
   local left_width, right_width = 0, 0
 
@@ -253,6 +254,9 @@ local merge_content = function(context)
     end
   end
 
+  if context.auto_expand_width then
+    remaining_width = context.container_width + remaining_width - huge_number
+  end
   if remaining_width > 0 and #right > 0 then
     table.insert(left, { text = string.rep(" ", remaining_width) })
   end
@@ -271,6 +275,7 @@ M.render = function(config, node, state, available_width)
     left_padding = config.left_padding,
     right_padding = config.right_padding,
     enable_character_fade = config.enable_character_fade,
+    auto_expand_width = state.window.auto_expand_width and state.window.position ~= "float",
   }
 
   render_content(config, node, state, context)

lua/neo-tree/ui/renderer.lua

@@ -15,7 +15,7 @@ local M = { resize_timer_interval = 50 }
 local ESC_KEY = vim.api.nvim_replace_termcodes("<ESC>", true, false, true)
 local default_popup_size = { width = 60, height = "80%" }
 local floating_windows = {}
-local draw, create_window, create_tree
+local draw, create_window, create_tree, render_tree
 
 local resize_monitor_timer = nil
 local start_resize_monitor = function()
@@ -42,7 +42,7 @@ local start_resize_monitor = function()
         if current_size ~= state.win_width then
           log.trace("Window size changed, redrawing tree")
           state.win_width = current_size
-          state.tree:render()
+          render_tree(state)
           speed_up_loops = 21 -- move to fast timer for the next 1000 ms
         end
       end
@@ -343,6 +343,10 @@ local prepare_node = function(item, state)
         end
       end
     end
+    state.longest_width_exact = math.max(
+      state.longest_width_exact,
+      vim.api.nvim_strwidth(line:content()) + 1
+    )
   end
 
   return line
@@ -562,7 +566,7 @@ M.position = {
 M.redraw = function(state)
   if state.tree and M.window_exists(state) then
     log.trace("Redrawing tree", state.name, state.id)
-    state.tree:render()
+    render_tree(state)
     log.trace("  Redrawing tree done", state.name, state.id)
   end
 end
@@ -922,6 +926,23 @@ M.window_exists = function(state)
   return window_exists
 end
 
+---Renders the given tree and expands window width if needed
+--@param state table The state containing tree to render. Almost same as state.tree:render()
+render_tree = function(state)
+  state.tree:render()
+  if state.window.auto_expand_width and state.window.position ~= "float" then
+    state.window.last_user_width = vim.api.nvim_win_get_width(0)
+    if state.longest_width_exact > state.window.last_user_width then
+      log.trace(
+        string.format("`auto_expand_width: on. Expanding width to %s.", state.longest_width_exact)
+      )
+      vim.api.nvim_win_set_width(0, state.longest_width_exact)
+      state.win_width = state.longest_width_exact
+      render_tree(state)
+    end
+  end
+end
+
 ---Draws the given nodes on the screen.
 --@param nodes table The nodes to draw.
 --@param state table The current state of the source.
@@ -968,7 +989,7 @@ draw = function(nodes, state, parent_id)
   state.win_width = utils.get_inner_win_width(state.winid)
   start_resize_monitor()
 
-  state.tree:render()
+  render_tree(state)
 
   -- draw winbar / statusbar
   require("neo-tree.ui.selector").set_source_selector(state)
@@ -1007,6 +1028,7 @@ M.show_nodes = function(sourceItems, state, parentId, callback)
   --local id = string.format("show_nodes %s:%s [%s]", state.name, state.force_float, state.tabnr)
   --utils.debounce(id, function()
   events.fire_event(events.BEFORE_RENDER, state)
+  state.longest_width_exact = 0
   local parent
   local level = 0
   if parentId ~= nil then
@@ -1086,7 +1108,7 @@ M.show_nodes = function(sourceItems, state, parentId, callback)
   else
     -- this was a force grouping of a lazy loaded folder
     state.win_width = utils.get_inner_win_width(state.winid)
-    state.tree:render()
+    render_tree(state)
   end
 
   vim.schedule(function()