feat(show_file_size): Support hidding size information when width goes below a cutoff

Author: evertonse

doc/nvim-tree-lua.txt

@@ -444,7 +444,8 @@ Following is the default configuration. See |nvim-tree-opts| for details.
         },
         size = {
           enable = false,
-          column_width = 12,
+          width_cutoff = 18,
+          column_width = 10,
           show_folder_size = false,
           format_unit = "double",
           noshow_folder_size_glyph = "•",
@@ -963,10 +964,16 @@ Configuration for file size display column
     Determine if we should render file size information.
       Type: `boolean`, Default: `false`
 
+    *nvim-tree.renderer.size.width_cutoff*
+    Whenever nvim-tree window has less width than this cutoff the
+    size information is hidden. If it goes back to having bigger width
+    then the cutoff, the information is shown again.
+      Type: `integer`, Default: `18`
+
     *nvim-tree.renderer.size.column_width*
     Determines the amount of space (in characters) the
     file size information will take.
-      Type: `integer`, Default: `12`
+      Type: `integer`, Default: `10`
 
     *nvim-tree.renderer.size.show_folder_size*
     Whether to show the size for folder as well.
@@ -2960,6 +2967,7 @@ highlight group is not, hard linking as follows: >
 |nvim-tree.renderer.size.format_unit|
 |nvim-tree.renderer.size.noshow_folder_size_glyph|
 |nvim-tree.renderer.size.show_folder_size|
+|nvim-tree.renderer.size.width_cutoff|
 |nvim-tree.renderer.special_files|
 |nvim-tree.renderer.symlink_destination|
 |nvim-tree.respect_buf_cwd|

lua/nvim-tree.lua

@@ -338,6 +338,19 @@ local function setup_autocommands(opts)
     })
   end
 
+  if opts.renderer.size.enable then
+    create_nvim_tree_autocmd({ "WinResized", "VimResized" }, {
+      -- NOTE: for some reason WinResized doesn't work with pattern
+      -- I don't really know why
+      -- pattern = "NvimTree_*",
+      callback = function(event)
+        if view.is_visible() and utils.is_nvim_tree_buf(event.buf) then
+          renderer.on_resize()
+        end
+      end,
+    })
+  end
+
   if opts.modified.enable then
     create_nvim_tree_autocmd({ "BufModifiedSet", "BufWritePost" }, {
       callback = function()
@@ -419,7 +432,8 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     },
     size = {
       enable = false,
-      column_width = 12,
+      width_cutoff = 18,
+      column_width = 10,
       show_folder_size = false,
       format_unit = "double",
       noshow_folder_size_glyph = "•",
@@ -656,6 +670,7 @@ local ACCEPTED_TYPES = {
   renderer = {
     size = {
       enable = { "boolean" },
+      width_cutoff = { "integer" },
       column_width = { "integer" },
       show_folder_size = { "boolean" },
       format_unit = { "function", "string" },
@@ -845,7 +860,7 @@ function M.setup(conf)
   end
 
   if M.config.renderer.size.column_width < 6 then
-    notify.warn "`size.right_padding` is a small number, problably won't show any size numbers, try using 12."
+    notify.warn "`size.right_padding` is a small number, problably won't show any size numbers, try using 10."
   end
 
   if M.config.renderer.size.format_unit == "single" then

lua/nvim-tree/commands.lua

@@ -1,5 +1,6 @@
 local api = require "nvim-tree.api"
 local view = require "nvim-tree.view"
+local renderer = require "nvim-tree.renderer"
 
 local M = {}
 

lua/nvim-tree/renderer/builder.lua

@@ -44,6 +44,8 @@ local M = {
 ---@field lines string[] includes icons etc.
 ---@field hl_args AddHighlightArgs[] line highlights
 ---@field signs string[] line signs
+---@field extmarks table<integer, HighlightedString[]>
+---@field size_extmarks table<integer, HighlightedString[]>
 ---@field private root_cwd string absolute path
 ---@field private index number
 ---@field private depth number
@@ -63,6 +65,7 @@ function Builder:new()
     markers = {},
     signs = {},
     extmarks = {},
+    size_extmarks = {}, -- Need to be separate from `extmarks` because of resize feature
   }
   setmetatable(o, self)
   self.__index = self
@@ -201,7 +204,7 @@ function Builder:format_line(indent_markers, arrows, icon, name, node)
   local added_len = 0
   local function add_to_end(t1, t2)
     if not t2 then
-      return
+      return t1
     end
     for _, v in ipairs(t2) do
       if added_len > 0 then
@@ -216,6 +219,7 @@ function Builder:format_line(indent_markers, arrows, icon, name, node)
     for _, v in ipairs(t2) do
       added_len = added_len + #v.str
     end
+    return t1
   end
 
   local line = { indent_markers, arrows }
@@ -239,6 +243,11 @@ function Builder:format_line(indent_markers, arrows, icon, name, node)
     self.extmarks[self.index] = rights
   end
 
+  local size_extmarks = add_to_end({}, M.decorator_size:icons_right_align(node))
+  if #size_extmarks > 0 then
+    self.size_extmarks[self.index] = size_extmarks
+  end
+
   return line
 end
 
@@ -446,9 +455,9 @@ end
 function Builder.setup(opts)
   M.opts = opts
 
-  -- priority order
+  M.decorator_size = DecoratorSize:new(opts)
+
   M.decorators = {
-    DecoratorSize:new(opts),
     DecoratorCut:new(opts),
     DecoratorCopied:new(opts),
     DecoratorDiagnostics:new(opts),

lua/nvim-tree/renderer/decorator/size.lua

@@ -1,24 +1,39 @@
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
+local view = require "nvim-tree.view"
+
 local Decorator = require "nvim-tree.renderer.decorator"
 
 ---@class DecoratorSize: Decorator
----@field icon HighlightedString|nil
+---@field width_cutoff integer
+---@field noshow_folder_size_glyph string
+---@field column_width integer
+---@field show_folder_size boolean
+---@field units string[]
+---@field format_unit function
+---@field format_size function
 local DecoratorSize = Decorator:new()
 
 ---@param opts table
 ---@return DecoratorSize
 function DecoratorSize:new(opts)
   local o = Decorator.new(self, {
     enabled = opts.renderer.size.enable,
-    noshow_folder_size_glyph = opts.renderer.size.noshow_folder_size_glyph or "",
-    column_width = opts.renderer.size.column_width,
-    show_folder_size = opts.renderer.size.show_folder_size,
-    format_unit = opts.renderer.size.format_unit, -- Assumed to be a function
-    units = { "B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" },
+    hl_pos = HL_POSITION.none,
     icon_placement = ICON_PLACEMENT.right_align,
   })
+  ---@cast o DecoratorSize
+
+  if not o.enabled then
+    return o
+  end
 
+  o.width_cutoff = opts.renderer.size.width_cutoff
+  o.noshow_folder_size_glyph = opts.renderer.size.noshow_folder_size_glyph or ""
+  o.column_width = opts.renderer.size.column_width
+  o.show_folder_size = opts.renderer.size.show_folder_size
+  o.units = { "B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" }
+  o.format_unit = opts.renderer.size.format_unit -- guaranteed to be a function
   o.format_size = function(size)
     local formatted = string
       .format("%.2f", size)
@@ -32,16 +47,11 @@ function DecoratorSize:new(opts)
   return o
 end
 
----@param node Node
----@return nil
-function DecoratorSize:calculate_highlight(_)
-  return nil
-end
-
 --- Convert a size to a human-readable format (e.g., KB, MB, GB) with fixed width
 ---@private
 ---@param size number size in bytes
 ---@return string
+--- edit: Since then I've moved a lot of ifs around getting down to only three, but I'll keep the comment just in case.
 ---NOTE: This function still try it's best to minified the string
 --- generated, but this implies that we have more than 3 branchs
 --- to determined how much bytes can we shave from the string to
@@ -50,7 +60,6 @@ end
 --- on self.column_width once at this object's construction.
 --- Basically, instead of this method, we would baking all ifs first to decide which function to bind to possible field `self.human_readable_size`
 --- I don't actually know if it would be faster without test.
---- edit: Since then I've moved a lot of ifs around getting down to only three, but I'll keep the comment just in case.
 function DecoratorSize:human_readable_size(size)
   -- Check for nan, negative, etc.
   if type(size) ~= "number" or size ~= size or size < 0 then
@@ -74,11 +83,11 @@ function DecoratorSize:human_readable_size(size)
   local result = size_str .. unit_str
 
   -- We Need a max length to align size redering properly
-  -- So the result must at at most this column width
+  -- So the result must have at most this column width
   local max_length = self.column_width
 
   if #result > max_length then
-    if (index + 1) < #self.units then
+    if index <= #self.units then
       size = size / 1024
       index = index + 1
       size_str = self.format_size(size)
@@ -97,7 +106,7 @@ function DecoratorSize:human_readable_size(size)
   -- If still too big after all that,
   -- then we just set to empty string
   if #result > max_length then
-    result = ""
+    result = string.format("%" .. max_length .. "s", "")
   end
 
   return result
@@ -106,6 +115,10 @@ end
 ---@param node Node
 ---@return HighlightedString[]|nil icons
 function DecoratorSize:calculate_icons(node)
+  if not self.enabled or view.get_current_width() < self.width_cutoff then
+    return nil
+  end
+
   local size = node and node.fs_stat and node.fs_stat.size or 0
   local folder_size_str = self.column_width > 0 and string.rep(" ", self.column_width - 1) .. self.noshow_folder_size_glyph or ""
   local icon = {

lua/nvim-tree/renderer/init.lua

@@ -14,12 +14,15 @@ local SIGN_GROUP = "NvimTreeRendererSigns"
 
 local namespace_highlights_id = vim.api.nvim_create_namespace "NvimTreeHighlights"
 local namespace_extmarks_id = vim.api.nvim_create_namespace "NvimTreeExtmarks"
+local namespace_size_extmarks_id = vim.api.nvim_create_namespace "NvimTreeSizeExtmarks"
 
 ---@param bufnr number
 ---@param lines string[]
 ---@param hl_args AddHighlightArgs[]
 ---@param signs string[]
-local function _draw(bufnr, lines, hl_args, signs, extmarks)
+---@param extmarks table<integer, HighlightedString[]>
+---@param size_extmarks table<integer, HighlightedString[]>
+local function _draw(bufnr, lines, hl_args, signs, extmarks, size_extmarks)
   if vim.fn.has "nvim-0.10" == 1 then
     vim.api.nvim_set_option_value("modifiable", true, { buf = bufnr })
   else
@@ -40,16 +43,8 @@ local function _draw(bufnr, lines, hl_args, signs, extmarks)
     vim.fn.sign_place(0, SIGN_GROUP, sign_name, bufnr, { lnum = i + 1 })
   end
 
-  vim.api.nvim_buf_clear_namespace(bufnr, namespace_extmarks_id, 0, -1)
-  for i, extname in pairs(extmarks) do
-    for _, mark in ipairs(extname) do
-      vim.api.nvim_buf_set_extmark(bufnr, namespace_extmarks_id, i, -1, {
-        virt_text = { { mark.str, mark.hl } },
-        virt_text_pos = "right_align",
-        hl_mode = "combine",
-      })
-    end
-  end
+  M.render_extmarks(bufnr, namespace_extmarks_id, extmarks)
+  M.render_extmarks(bufnr, namespace_size_extmarks_id, size_extmarks)
 end
 
 function M.render_hl(bufnr, hl)
@@ -66,6 +61,50 @@ function M.render_hl(bufnr, hl)
   end
 end
 
+function M.render_extmarks(bufnr, ns_id, extmarks)
+  if not bufnr or not vim.api.nvim_buf_is_loaded(bufnr) then
+    return
+  end
+  vim.api.nvim_buf_clear_namespace(bufnr, ns_id, 0, -1)
+  for i, extname in pairs(extmarks) do
+    for _, mark in ipairs(extname) do
+      vim.api.nvim_buf_set_extmark(bufnr, ns_id, i, -1, {
+        virt_text = { { mark.str, mark.hl } },
+        virt_text_pos = "right_align",
+        hl_mode = "combine",
+      })
+    end
+  end
+end
+
+-- Here we do a partial redraw of only a subsection of extra marks.
+-- We could simply call reloaders.reload(), but that would be substantially slower.
+-- Calling `nvim_buf_clear_namespace` to hide size information
+-- and `render_extmarks` to show again is preferable in place of
+-- reloading all decorators, nodes and lines from scratch, since resize does not trigger a reload.
+local redraw_size_extmarks = false
+function M.on_resize()
+  if M.builder == nil then
+    return
+  end
+
+  local bufnr = view.get_bufnr()
+
+  if view.get_current_width() < M.config.size.width_cutoff then
+    redraw_size_extmarks = true
+    vim.api.nvim_buf_clear_namespace(bufnr, namespace_size_extmarks_id, 0, -1)
+    return
+  end
+
+  -- If we got here, we only need to know if we should redraw
+  -- We don't have to check if decorator_size is enbaled, because if it's
+  -- not, then size_extmarks would've been empty
+  if redraw_size_extmarks then
+    redraw_size_extmarks = false
+    M.render_extmarks(bufnr, namespace_size_extmarks_id, M.builder.size_extmarks)
+  end
+end
+
 function M.draw()
   local bufnr = view.get_bufnr()
   if not core.get_explorer() or not bufnr or not vim.api.nvim_buf_is_loaded(bufnr) then
@@ -77,11 +116,11 @@ function M.draw()
   local cursor = vim.api.nvim_win_get_cursor(view.get_winnr() or 0)
   icon_component.reset_config()
 
-  local builder = Builder:new():build()
-
-  _draw(bufnr, builder.lines, builder.hl_args, builder.signs, builder.extmarks)
+  redraw_size_extmarks = false
+  M.builder = Builder:new():build()
+  _draw(bufnr, M.builder.lines, M.builder.hl_args, M.builder.signs, M.builder.extmarks, M.builder.size_extmarks)
 
-  if cursor and #builder.lines >= cursor[1] then
+  if cursor and #M.builder.lines >= cursor[1] then
     vim.api.nvim_win_set_cursor(view.get_winnr() or 0, cursor)
   end
 
@@ -94,11 +133,10 @@ end
 
 function M.setup(opts)
   M.config = opts.renderer
-
+  M.builder = nil
   _padding.setup(opts)
   full_name.setup(opts)
   icon_component.setup(opts)
-
   Builder.setup(opts)
 end
 

lua/nvim-tree/view.lua

@@ -576,6 +576,13 @@ function M.configure_width(width)
   end
 end
 
+---Get effective width, works on float window
+---@return integer
+function M.get_current_width()
+  local view_winnr = M.get_winnr()
+  return view_winnr and vim.api.nvim_win_get_width(view_winnr or 0) or 0
+end
+
 function M.setup(opts)
   local options = opts.view or {}
   M.View.centralize_selection = options.centralize_selection