feat(show_file_size): optionally show Size Information on right column #2857

evertonse · 2024-07-30T07:40:01Z

Description

This PR make nvim-tree be able to display file size information as a decoration. It uses newly introduced right_align feature to create a column that shows size info. It allows to customization options to display file sizes in a human-readable format (e.g., MB, GB). It also exposes the highlight group NvimTreeFileSize.

Showcase

Setup:

require'nvim-tree'.setup {
  renderer = {
    size = {
      enable = true,
      column_width = 12, -- max chars allowed to fill the column
      show_folder_size = false,
      format_unit = "double", -- or "single" or a custom function
    }
  }
}

Improvements that could be made:

Conditionally show file size information based on the current nvim-tree width in both floating and normal views.

EDIT: This improvement were made. We now support conditionally hiding size information based on current width and width cutoff setting as shown below.

2024-08-01.01-16-10.mp4

The hiding is decently fast because it only does a partial redraw of extra marks as opposed to reloading the whole tree everytime the cutoff is triggered.

…izes

…t shown

…s below a cutoff

alex-courtis · 2024-08-03T07:22:40Z

This looks great; I'm limited by time however I will get to it.

alex-courtis · 2024-08-04T05:15:14Z

Looks like we might need special handling for dotted files:

alex-courtis · 2024-08-04T05:23:06Z

lua/nvim-tree/renderer/init.lua

+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.


alex-courtis · 2024-08-04T05:38:50Z

Looks like some inconsistency around right_align icons. Every icon right:

Bookmarks go far far right for dotfiles unless there's another icon.
They lose the final character of the name, in this case bookmarking .clang-format will remove the t.

alex-courtis · 2024-08-04T05:27:38Z

doc/nvim-tree-lua.txt

+    file size information will take.
+      Type: `integer`, Default: `10`
+
+    *nvim-tree.renderer.size.show_folder_size*


I'm not sure how much value this is; it's only showing the fs_stat size - the folder's size, rather than the content size.

Could we just leave folders out completely?

As of right now there's no value indeed, but I'd like to support content size information.
What do you think two approaches to getting content size of a folder:

recursively calculate once the content size for each folder, and then update folder fize information as files are moved or changed

call external df -h -s (there must the something like it for windows) on the folder and render that.

2. call external df -h -s (there must the something like it for windows) on the folder and render that.

That would be really transparent and a good default for most users. It could be a user configurable like trash.cmd so that windows users could do whatever they need to do, and linux/macos users could use an alternate like tree

recursively calculate once the content size for each folder, and then update folder fize information as files are moved or changed

That would work well as it would sidestep any performance issues:
The watchers get a notification for the directory itself so they could do it in the async job. We'd just need to recalculate folders up the tree afterwards.
R could calculate everything. It's synchronous, but we know that a full refresh takes time.

Do you want to do folders in a follow up PR? File sizes is pretty much ready to go...

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

alex-courtis · 2024-08-04T05:45:51Z

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

+  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" }


Can we please use the IEC KiB MiB etc.? Someone will complain about SI units...

/nit can this be an enum? We could expose it to the user via API luadoc.

Yeah, actually.
An enum might be the cleanest ideia.

alex-courtis · 2024-08-04T06:02:21Z

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

+  -- on a given iteration you have :
+  -- 1024 YB, then index is equal to #units, normally we would devide again,
+  -- but we don't have more units, so keep as is.
+  while size >= 1024 and index < #self.units do


Could we do something really dumb like:

convert size to a string

calculate string length

div 3 to get the index

alex-courtis · 2024-08-04T06:08:31Z

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


This happens for a few autocommands. You can remove the comment.

Oh, ok, ty for info

alex-courtis · 2024-08-04T06:09:42Z

lua/nvim-tree.lua

@@ -827,6 +859,22 @@ function M.setup(conf)
    log.raw("config", "%s\n", vim.inspect(opts))
  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 10."


nvim-tree is a sharp tool, users can cut themselves as they wish.

Whenever we try to do something like this users complain vehemently.

Glad to know it

lua/nvim-tree/appearance/init.lua

alex-courtis · 2024-08-04T06:17:21Z

doc/nvim-tree-lua.txt

+          column_width = 10,
+          show_folder_size = false,
+          format_unit = "double",
+          noshow_folder_size_glyph = "•",


I'm always nervous about too many options however I predict that users will want:
precision = 2

I know that I'll be setting it to 0.

yes, as I'm using I feel the 2 precision is just unnecessary. I'll get on it.

alex-courtis

This is looking fantastic! You are quite the prolific contributor...

A few bugs, some option tweaking and this should be good.

I'll dogfood this foor a week.

evertonse · 2024-08-04T08:16:19Z

This is looking fantastic! You are quite the prolific contributor...

A few bugs, some option tweaking and this should be good.

I'll dogfood this foor a week.

Ty, ty.
I'll find some time this week to get to those bugs.

alex-courtis · 2025-01-27T00:37:06Z

Closing as this PR is stale. Please reopen if you wish to continue this work.

feat(file_size): Add options to show a right column display of file s…

cdbd154

…izes

evertonse marked this pull request as draft July 30, 2024 07:41

feat(file_size): Add another option for showing a symbol on folder no…

8d44388

…t shown

evertonse force-pushed the feat/show_file_size branch from 6fdbb51 to 8d44388 Compare July 30, 2024 07:49

feat(show_file_size): Support hidding size information when width goe…

1b93ce0

…s below a cutoff

evertonse changed the title ~~feat(show_file_size):~~ feat(show_file_size): Optionally show a right column with size information Aug 1, 2024

evertonse added 2 commits August 1, 2024 01:36

style: fix linting

a956ea7

docs: consolidate comments

2e834d3

evertonse changed the title ~~feat(show_file_size): Optionally show a right column with size information~~ feat(show_file_size): optionally show Size Information on right column Aug 1, 2024

evertonse marked this pull request as ready for review August 1, 2024 04:54

fix: size_decorator ordering

93f4c5f

alex-courtis reviewed Aug 4, 2024

View reviewed changes

lua/nvim-tree/appearance/init.lua Show resolved Hide resolved

alex-courtis reviewed Aug 4, 2024

View reviewed changes

alex-courtis requested changes Aug 4, 2024

View reviewed changes

alex-courtis closed this Jan 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(show_file_size): optionally show Size Information on right column #2857

feat(show_file_size): optionally show Size Information on right column #2857

evertonse commented Jul 30, 2024 •

edited

Loading

alex-courtis commented Aug 3, 2024

alex-courtis commented Aug 4, 2024

alex-courtis Aug 4, 2024

alex-courtis commented Aug 4, 2024 •

edited

Loading

alex-courtis Aug 4, 2024

evertonse Aug 4, 2024 •

edited

Loading

alex-courtis Aug 10, 2024

alex-courtis Aug 10, 2024

alex-courtis Aug 4, 2024

alex-courtis Aug 4, 2024

evertonse Aug 4, 2024

alex-courtis Aug 4, 2024

alex-courtis Aug 4, 2024

evertonse Aug 4, 2024

alex-courtis Aug 4, 2024

evertonse Aug 4, 2024

alex-courtis Aug 4, 2024

evertonse Aug 4, 2024

alex-courtis left a comment

evertonse commented Aug 4, 2024

alex-courtis commented Jan 27, 2025

feat(show_file_size): optionally show Size Information on right column #2857

feat(show_file_size): optionally show Size Information on right column #2857

Conversation

evertonse commented Jul 30, 2024 • edited Loading

Description

Showcase

Setup:

Improvements that could be made:

alex-courtis commented Aug 3, 2024

alex-courtis commented Aug 4, 2024

Choose a reason for hiding this comment

alex-courtis commented Aug 4, 2024 • edited Loading

Choose a reason for hiding this comment

evertonse Aug 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-courtis left a comment

Choose a reason for hiding this comment

evertonse commented Aug 4, 2024

alex-courtis commented Jan 27, 2025

evertonse commented Jul 30, 2024 •

edited

Loading

alex-courtis commented Aug 4, 2024 •

edited

Loading

evertonse Aug 4, 2024 •

edited

Loading