Update 2026-01-31

Update 2026-01-27
2026-02-04 06:32:03 +00:00 · 2026-01-31 17:45:16 +02:00
parent 8c606045e1
commit 5324f54618
73 changed files with 6508 additions and 5373 deletions
--- a/config/yazi/plugins/what-size.yazi/README.md
+++ b/config/yazi/plugins/what-size.yazi/README.md
@@ -14,31 +14,46 @@ what-size supports Yazi on Linux, macOS, and Windows.

 ### Yazi

- yazi `25.5.28` and onwards since commit `c5c939b` ([link](https://github.com/pirafrank/what-size.yazi/commit/c5c939bb37ec1d132c942cf5724d4e847acc2977))
- yazi `25.x`-`25.4.8` since commit `fce1778` ([link](https://github.com/pirafrank/what-size.yazi/commit/fce1778d911621dc57796cdfdf11dcda3c2e28de))
- yazi `0.4.x` since commit `2780de5` ([link](https://github.com/pirafrank/what-size.yazi/commit/2780de5aeef1ed16d1973dd6e0cd4d630c900d56))
- yazi `0.3.x` up to commit `f08f7f2` ([link](https://github.com/pirafrank/what-size.yazi/commit/f08f7f2d5c94958ac4cb66c51a7c24b4319c6c93))
+In an effort to make things easy, I keep `compatibility/yazi-x.y.z` branches with each pointing to the most up-to-date commit compatible with yazi release `x.y.z`. Full table below.
+
+|Yazi releases|what-size branch name|
+|---|---|
+|*[latest stable](https://github.com/sxyazi/yazi/releases/latest)*|`main`|
+|`25.5.28`|`compatibility/yazi-25.5.28`|
+|`25.x`-`25.4.8`|`compatibility/yazi-25.4.8`|
+|`0.4.x`|`compatibility/yazi-0.4.x`|
+|`0.3.x`|`compatibility/yazi-0.3.x`|
+
+Please notice that `nightly` releses may work but are not explicitly supported.

 ## Requirements

+### Before Yazi's version 25.5.28
+
+- Use this commit: [Old version](https://github.com/pirafrank/what-size.yazi/commit/d8966568f2a80394bf1f9a1ace6708ddd4cc8154)
 - `du` on Linux and macOS
 - PowerShell on Windows

+### On Yazi's version 25.5.28 or newer
+
+- No requirement
+
 ## Installation

 ```sh
 ya pkg add pirafrank/what-size
 ```

-or
+or (**DEPRECATED** - use only for yazi `25.4.8` and older):

-**DEPRECATED**
 ```sh
 ya pack -a 'pirafrank/what-size'
 ```

 ## Usage

+### Keymap
+
 Add this to your `~/.config/yazi/keymap.toml`:

 ```toml
@@ -54,18 +69,30 @@ If you want to copy the result to clipboard, you can add `--clipboard` or `-c` a
 [[mgr.prepend_keymap]]
 on   = [ ".", "s" ]
 run  = "plugin what-size -- '--clipboard'"
-desc = "Calc size of selection or cwd"
+desc = "Calc size of sel/cwd + paste to clipboard"
 ```

 ```toml
 [[mgr.prepend_keymap]]
 on = [ ".", "s" ]
 run = "plugin what-size -- '-c'"
-desc = "Calc size of selection or cwd"
+desc = "Calc size of sel/cwd + paste to clipboard"
 ```

 Change to whatever keybinding you like.

+### User interface (optional)
+
+If you want to place the size value exactly where you want, modify the priority value. Also changing two strings `LEFT` and `RIGHT` will add them to the left and right side of the value. Remember to add to and change these lines inside your `init.lua` file if you want to customize, or the plugin will use this configuration by default:
+
+```lua
+require("what-size"):setup({
+    priority = 400,
+    LEFT = "",
+    RIGHT = " ",
+})
+```
+
 ## Feedback

 If you have any feedback, suggestions, or ideas please let me know by opening an issue.
@@ -82,6 +109,16 @@ YAZI_LOG=debug yazi

 Logs will be saved to `~.local/state/yazi/yazi.log` file.

+### Plugin definition
+
+The repo already has a `.luarc.json` file. You only need to run the following to add the `types` plugin dependency:
+
+```sh
+ya pkg add yazi-rs/plugins:types
+```
+
+as per the [docs](https://github.com/yazi-rs/plugins/tree/main/types.yazi).
+
 ## Contributing

 Contributions are welcome. Please fork the repository and submit a PR.
--- a/config/yazi/plugins/what-size.yazi/main.lua
+++ b/config/yazi/plugins/what-size.yazi/main.lua
@@ -1,102 +1,238 @@
+--- @since 25.5.28
+-- This plugin is now only supporting Yazi's version 25.5.28 or newer
+-- since commit https://github.com/sxyazi/yazi/pull/2695

-- function to get paths of selected elements or current directory
-- if no elements are selected
-local get_paths = ya.sync(function()
-  local paths = {}
-  -- get selected files
-  for _, u in pairs(cx.active.selected) do
-    paths[#paths + 1] = tostring(u)
-  end
-  -- if no files are selected, get current directory
-  if #paths == 0 then
-    if cx.active.current.cwd then
-      paths[1] = tostring(cx.active.current.cwd)
-    else
-      ya.err("what-size would return nil paths")
+-- TODO: Asynchronous calculating and dynamic displaying in statusline,
+-- perhaps by using this:
+--      https://yazi-rs.github.io/docs/plugins/utils/#ps.sub
+-- and by using ui.render() method
+-- See also:
+--      https://github.com/sxyazi/yazi/pull/1903
+--      https://yazi-rs.github.io/docs/dds/#kinds
+--      https://github.com/sxyazi/yazi/pull/2210
+--      https://github.com/imsi32/yatline.yazi
+-- TODO: Add options to choose displaying in popup box or in statusline
+-- TODO: Add spotter and previewer widget to support simpler displaying
+-- TODO: Remove note [1] and [2] after add them to the setup
+-- configuration
+
+-- Get selected paths {{{1
+local get_selected_paths = ya.sync(function(state)
+    local result = {}
+    if cx and cx.active and cx.active.selected then
+        for _, url in pairs(cx.active.selected) do
+            result[#result + 1] = url
+        end
    end
-  end
-  return paths
+    return result
 end)
-
-- Function to get total size from output
-- Unix use `du`, Windows use PowerShell
+-- }}}1
+-- Get current working directory in sync context {{{1
+local get_cwd = ya.sync(function(state)
+    if cx and cx.active and cx.active.current and cx.active.current.cwd then
+        return cx.active.current.cwd
+    end
+    return nil
+end)
+-- }}}1
+-- Function to get paths of selected files or current directory {{{1
+--- @param selected table Table of selected urls
+--- @return paths table Table of selected urls
+local function get_paths(selected)
+    -- If no files are selected, get current directory
+    if #selected == 0 then
+        local paths = {}
+        -- Try fs.cwd() first (async, optimized for slow devices)
+        local cwd, err = fs.cwd()
+        if cwd then
+            paths[1] = cwd
+        else
+            -- Fallback to cx.active.current.cwd (via sync block)
+            local sync_cwd = get_cwd()
+            if sync_cwd then
+                paths[1] = sync_cwd
+            else
+                ya.notify {
+                    title = "What size",
+                    content = "Cannot get current working directory: " .. (err or "unknown error"),
+                    timeout = 5,
+                    level = "error",
+                }
+            end
+        end
+        return paths
+    else
+        -- This variable is a table of urls already
+        return selected
+    end
+end
+-- }}}1
+-- Function to get total size using Yazi's fs.calc_size API {{{1
+-- See: https://github.com/sxyazi/yazi/pull/2695
+-- See: https://github.com/sxyazi/yazi/blob/main/yazi-plugin/preset/plugins/folder.lua
 local function get_total_size(items)
-  local is_windows = package.config:sub(1,1) == '\\'
-
-  if is_windows then
    local total = 0
-    for _, path in ipairs(items) do
-      path = path:gsub('"', '\\"')
-      local ps_cmd = string.format(
-      [[powershell -Command "& { $p = '%s'; if (Test-Path $p) { if ((Get-ChildItem -Path $p -Recurse -Force -ErrorAction SilentlyContinue | Measure-Object Length -Sum).Sum) { (Get-ChildItem -Path $p -Recurse -Force -ErrorAction SilentlyContinue | Measure-Object Length -Sum).Sum } else { (Get-Item $p).Length } } }"]],
-      path
-      )
-      local pipe = io.popen(ps_cmd)
-      local result = pipe:read("*a")
-      -- Debug
-      -- ya.notify {
-      --     title = "Debug Output",
-      --     content = result,
-      --     timeout = 5,
-      -- }
-      pipe:close()
-      local num = tonumber(result)
-      if num then total = total + num end
+    for _, url in ipairs(items) do
+        local it = fs.calc_size(url)
+        while true do
+            local next = it:recv()
+            if next then
+                total = total + next
+            else
+                break
+            end
+        end
    end
    return total
-  else
-    local arg = ya.target_os() == "macos" and "-scA" or "-scb"
-    -- pass args as string
-    local cmd = Command("du"):arg(arg)
-    for _, path in ipairs(items) do
-      cmd = cmd:arg(path)
-    end
-    local output, err = cmd:output()
-
-    if not output then
-      ya.err("Failed to run du: " .. err)
-    end
-    local lines = {}
-    for line in output.stdout:gmatch("[^\n]+") do
-      lines[#lines + 1] = line
-    end
-    local last_line = lines[#lines]
-    local size = tonumber(last_line:match("^(%d+)"))
-    return ya.target_os() == "macos" and size * 512 or size
-  end
 end
-
-- Function to format file size
+-- }}}1
+-- Function to format files/folders size {{{1
 local function format_size(size)
-  local units = { "B", "KB", "MB", "GB", "TB" }
-  local unit_index = 1
-  while size > 1024 and unit_index < #units do
-    size = size / 1024
-    unit_index = unit_index + 1
-  end
-  return string.format("%.2f %s", size, units[unit_index])
-end
-
-return {
-  -- as per doc: https://yazi-rs.github.io/docs/plugins/overview#functional-plugin
-  entry = function(_, job)
-    -- defaults not to use clipboard, use it only if required by the user
-    local clipboard = job.args.clipboard == true or job.args[1] == "--clipboard" or job.args[1] == "-c"
-    local items = get_paths()
-
-    local total_size = get_total_size(items)
-    local formatted_size = format_size(total_size)
-
-    local notification_content = "Total size: " .. formatted_size
-    if clipboard then
-      ya.clipboard(formatted_size)
-      notification_content = notification_content .. "\nCopied to clipboard."
+    local units = { "B", "KB", "MB", "GB", "TB" }
+    local unit_index = 1
+    while size > 1024 and unit_index < #units do
+        size = size / 1024
+        unit_index = unit_index + 1
    end
+    return string.format("%.2f %s", size, units[unit_index])
+end
+-- }}}1
+-- Generic setter for any state field {{{1
+local set_state = ya.sync(function(state, field, value)
+    state[field] = value
+end)
+-- }}}1
+-- Generic getter for any state field {{{1
+local get_state = ya.sync(function(state, field)
+    return state[field] or nil
+end)
+-- }}}1
+-- Get selecting state {{{1
+local get_selected = ya.sync(function()
+    return (not cx.active.mode.is_visual) and (#cx.active.selected ~= 0)
+end)
+-- }}}1
+-- Set separators {{{1
+local set_separator = ya.sync(function(state, table)
+    if table and table.LEFT and table.RIGHT then
+        state.LEFT = table.LEFT
+        state.RIGHT = table.RIGHT
+    else
+        state.LEFT = " "
+        state.RIGHT = " "
+    end
+end)
+-- }}}1
+-- Get separators {{{1
+local get_separator = ya.sync(function(state)
+    return {state.LEFT, state.RIGHT}
+end)
+-- }}}1
+-- Redraw statusline {{{1
+local redraw_statusline = ya.sync(function(state)
+    ui.render()
+end)
+-- }}}1
+-- Set ui line in statusline for size, clean up when no selection exists {{{1
+-- @return of get_state("renewed_state") number or nil Returning -1
+--     means never show the size - suitable for setup function;
+--     returning 0 means the size will be shown after triggering the
+--     calculation, but without unselect the selections, or it will be
+--     hidden after nothing is selected; returning 1 means hidden when
+--     nothing is selected as said.
+local set_ui_line = function(state)
+    local sep_left, sep_right = table.unpack(get_separator())

-    ya.notify {
-      title = "What size",
-      content = notification_content,
-      timeout = 4,
-    }
-  end,
-}
+    if get_state("renewed_state") == -1 then
+        return ""
+    else
+        if not get_selected() then
+            if not get_state("is_held") then
+                set_state("renewed_state", 1)
+                return ""
+            end
+            -- NOTE [1]: Set this line if DON'T want to clear the value
+            -- in the statusline when move the cursor, after calculating
+            -- with NO selection(s). Or just return ""
+            return ui.Span(sep_left .. get_state("size") .. sep_right)
+        end
+        if get_state("renewed_state") == 0 then
+            return ui.Span(sep_left .. get_state("size") .. sep_right)
+        else
+            -- NOTE [2]: Set this line if want to clear the value in the
+            -- statusline when move the cursor, after calculating WITH
+            -- selection: return ui.Span(sep_left .. get_state("size") .. sep_right)
+            -- or just remove after the unselection like below
+            return ""
+        end
+    end
+end
+-- }}}1
+
+--- @since 25.12.29
+return {
+    entry = function(self, job)
+        local clipboard = job.args.clipboard or job.args[1] == '-c'
+
+        local selected = get_selected_paths()
+        local prepend_msg
+        -- Keep showing the size after CWD calculation (no selections)
+        if #selected == 0 then
+            set_state("is_held", true)
+            prepend_msg = "Current Dir: "
+        else
+            set_state("is_held", false)
+            prepend_msg = "Selected: "
+        end
+
+        local items = get_paths(selected)
+        if not items or #items == 0 then
+            ya.notify {
+                title = "What size",
+                content = "Failed to get paths",
+                timeout = 5,
+            }
+            return
+        end
+
+        local total_size = get_total_size(items)
+        if not total_size then
+            ya.notify {
+                title = "What size",
+                content = "Failed to calculate size",
+                timeout = 5,
+            }
+            return
+        end
+
+        local formatted_size = format_size(total_size)
+
+        local notification_content = prepend_msg .. formatted_size
+        if clipboard then
+            ya.clipboard(formatted_size)
+            notification_content = notification_content .. "\nCopied to clipboard."
+        end
+        ya.notify {
+            title = "What size",
+            content = notification_content,
+            timeout = 4,
+        }
+
+        set_state("size", formatted_size)
+        set_state("renewed_state", 0)
+        redraw_statusline()
+    end,
+
+    setup = function(state, opts)
+        opts = opts or {}
+        local priority = opts.priority or 400
+        set_separator(opts)
+        set_state("renewed_state", -1)
+
+        if Status and type(Status.children_add) == "function" then
+            Status:children_add(set_ui_line, priority, Status.RIGHT)
+        else
+            ya.err("Failed to initialize status bar: Status or children_add not available")
+        end
+    end,
+}