feat(file_size): Add another option for showing a symbol on folder not shown

Author: evertonse

doc/nvim-tree-lua.txt

@@ -442,6 +442,13 @@ Following is the default configuration. See |nvim-tree-opts| for details.
             none = " ",
           },
         },
+        size = {
+          enable = false,
+          column_width = 12,
+          show_folder_size = false,
+          format_unit = "double",
+          noshow_folder_size_glyph = "•",
+        },
         icons = {
           web_devicons = {
             file = {
@@ -514,12 +521,6 @@ Following is the default configuration. See |nvim-tree-opts| for details.
         cmd = "",
         args = {},
       },
-      size = {
-        enable = true,
-        column_width = 12,
-        show_folder_size = false,
-        format_unit = "double",
-      },
       git = {
         enable = true,
         show_on_dirs = true,
@@ -847,7 +848,7 @@ Use nvim-tree in a floating window.
  5.3 OPTS: RENDERER                                  *nvim-tree-opts-renderer*
 
 Highlight precedence, additive:
-  git < opened < modified < bookmarked < diagnostics < copied < cut
+  git < opened < modified < bookmarked < diagnostics < copied < cut < size
 
 *nvim-tree.renderer.add_trailing*
 Appends a trailing slash to folder names.
@@ -955,6 +956,37 @@ Configuration options for tree indent markers.
           none = " ",
         }
 <
+*nvim-tree.renderer.size*
+Configuration for file size display column
+
+    *nvim-tree.renderer.size.enable*
+    Determine if we should render file size information.
+      Type: `boolean`, Default: `false`
+
+    *nvim-tree.renderer.size.column_width*
+    Determines the amount of space (in characters) the
+    file size information will take.
+      Type: `integer`, Default: `12`
+
+    *nvim-tree.renderer.size.show_folder_size*
+    Whether to show the size for folder as well.
+      Type: `boolean`, Default: `false`
+
+    *nvim-tree.renderer.size.format_unit*
+    Determines how format unit is displayed.
+    If a string is passed we have the options:
+    - `"single"` : Show only 1 character for unit. Ex: for 10.4 Megabytes we render "10.4M"
+    - `"double"` : Show only 2 character for unit and add a space in between. Ex: "10.4 MB"
+
+    If more controle we needed, such as lowercase unit, a function can be
+    passed by the user that takes one of the possible units as string.
+    units = { "B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" }
+      Type: `string | fun(unit: string): string`, Default: `"double"`
+
+    *nvim-tree.renderer.size.noshow_folder_size_glyph*
+    Glyph to be shown when `nvim-tree.renderer.size.show_folder_size` is disabled.
+      Type: `string`, Default: `"•"`
+
 *nvim-tree.renderer.icons*
 Configuration options for icons.
 
@@ -2922,6 +2954,12 @@ highlight group is not, hard linking as follows: >
 |nvim-tree.renderer.indent_markers.inline_arrows|
 |nvim-tree.renderer.indent_width|
 |nvim-tree.renderer.root_folder_label|
+|nvim-tree.renderer.size|
+|nvim-tree.renderer.size.column_width|
+|nvim-tree.renderer.size.enable|
+|nvim-tree.renderer.size.format_unit|
+|nvim-tree.renderer.size.noshow_folder_size_glyph|
+|nvim-tree.renderer.size.show_folder_size|
 |nvim-tree.renderer.special_files|
 |nvim-tree.renderer.symlink_destination|
 |nvim-tree.respect_buf_cwd|

lua/nvim-tree.lua

@@ -417,6 +417,13 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
         none = " ",
       },
     },
+    size = {
+      enable = false,
+      column_width = 12,
+      show_folder_size = false,
+      format_unit = "double",
+      noshow_folder_size_glyph = "•",
+    },
     icons = {
       web_devicons = {
         file = {
@@ -489,12 +496,6 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     cmd = "",
     args = {},
   },
-  size = {
-    enable = true,
-    column_width = 12,
-    show_folder_size = false,
-    format_unit = "double",
-  },
   git = {
     enable = true,
     show_on_dirs = true,
@@ -653,18 +654,19 @@ local ACCEPTED_TYPES = {
     },
   },
   renderer = {
+    size = {
+      enable = { "boolean" },
+      column_width = { "integer" },
+      show_folder_size = { "boolean" },
+      format_unit = { "function", "string" },
+      noshow_folder_size_glyph = { "string" },
+    },
     group_empty = { "boolean", "function" },
     root_folder_label = { "function", "string", "boolean" },
   },
   update_focused_file = {
     exclude = { "function" },
   },
-  size = {
-    enable = { "boolean" },
-    column_width = { "integer" },
-    show_folder_size = { "boolean" },
-    format_unit = { "function", "string" },
-  },
   git = {
     disable_for_dirs = { "function" },
   },
@@ -699,6 +701,9 @@ local ACCEPTED_STRINGS = {
     highlight_bookmarks = { "none", "icon", "name", "all" },
     highlight_diagnostics = { "none", "icon", "name", "all" },
     highlight_clipboard = { "none", "icon", "name", "all" },
+    size = {
+      format_unit = { "single", "double" },
+    },
     icons = {
       git_placement = { "before", "after", "signcolumn", "right_align" },
       modified_placement = { "before", "after", "signcolumn", "right_align" },
@@ -710,9 +715,6 @@ local ACCEPTED_STRINGS = {
   help = {
     sort_by = { "key", "desc" },
   },
-  size = {
-    format_unit = { "single", "double" },
-  },
 }
 
 ---@param conf table|nil
@@ -842,18 +844,18 @@ function M.setup(conf)
     log.raw("config", "%s\n", vim.inspect(opts))
   end
 
-  if M.config.size.column_width < 6 then
+  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."
   end
 
-  if M.config.size.format_unit == "single" then
+  if M.config.renderer.size.format_unit == "single" then
     -- The unit. Ex: 10.12M
-    M.config.size.format_unit = function(unit)
+    M.config.renderer.size.format_unit = function(unit)
       return string.format("%1s", unit:sub(1, 1))
     end
-  elseif M.config.size.format_unit == "double" then
+  elseif M.config.renderer.size.format_unit == "double" then
     -- The unit. Ex: 10.12 MB
-    M.config.size.format_unit = function(unit)
+    M.config.renderer.size.format_unit = function(unit)
       return string.format(" %2s", unit)
     end
   end

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

@@ -10,10 +10,11 @@ local DecoratorSize = Decorator:new()
 ---@return DecoratorSize
 function DecoratorSize:new(opts)
   local o = Decorator.new(self, {
-    enabled = opts.size.enable,
-    column_width = opts.size.column_width,
-    show_folder_size = opts.size.show_folder_size,
-    format_unit = opts.size.format_unit, -- Assumed to be a function
+    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" },
     icon_placement = ICON_PLACEMENT.right_align,
   })
@@ -32,7 +33,7 @@ function DecoratorSize:new(opts)
 end
 
 ---@param node Node
----@return string|nil group
+---@return nil
 function DecoratorSize:calculate_highlight(_)
   return nil
 end
@@ -41,14 +42,15 @@ end
 ---@private
 ---@param size number size in bytes
 ---@return string
----NOTE: This function tries it's best to minified the string
+---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
---- comply to self.max_lengh. Since we know self.max_length doesn't
---- change, a better way would be decide a version of human_readable_size based
---- on self.max_lenght once at this object's construction.
+--- comply to self.column_width. Since we know self.column_width doesn't
+--- change, a better way could be to decide a version of 'human_readable_size' based
+--- 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, but most likely it would be faster.
+--- 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
@@ -77,7 +79,6 @@ function DecoratorSize:human_readable_size(size)
 
   if #result > max_length then
     if (index + 1) < #self.units then
-      vim.fn.confirm(result)
       size = size / 1024
       index = index + 1
       size_str = self.format_size(size)
@@ -106,7 +107,7 @@ end
 ---@return HighlightedString[]|nil icons
 function DecoratorSize:calculate_icons(node)
   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) .. "-" or ""
+  local folder_size_str = self.column_width > 0 and string.rep(" ", self.column_width - 1) .. self.noshow_folder_size_glyph or ""
   local icon = {
     str = (self.show_folder_size or node.nodes == nil) and self:human_readable_size(size) or folder_size_str,
     hl = { "NvimTreeFileSize" },