feat!: show file stats in columns, add sort commands (#1107)

To disable the new columns, see: #1107 (comment)

Author: cseickel

README.md

@@ -4,7 +4,20 @@ Neo-tree is a Neovim plugin to browse the file system and other tree like
 structures in whatever style suits you, including sidebars, floating windows,
 netrw split style, or all of them at once!
 
-![Neo-tree file system](https://github.com/nvim-neo-tree/resources/blob/main/images/Neo-tree-with-right-aligned-symbols.png)
+### Neo-tree filesystem as Sidebar:
+
+This screenshot shows Neo-tree opened in the traditional sidebar layout:
+
+![Neo-tree file system sidebar](https://github.com/nvim-neo-tree/resources/blob/main/images/Neo-tree-with-right-aligned-symbols.png)
+
+### Neo-tree filesystem as Split
+
+The below screenshot shows Neo-tree opened as a normal split (`:Neo-tree position=current`). When opened in this way,
+there is more room so the extra detail columns can be shown. This screenshot also shows how the contents can be
+sorted on any column. In this example, we are sorted on "Size" descending:
+
+![Neo-tree file system
+details](https://github.com/nvim-neo-tree/resources/blob/main/images/Neo-tree-with-file-details-and-sort.png)
 
 ### Breaking Changes BAD :bomb: :imp:
 
@@ -190,6 +203,23 @@ use {
               conflict  = "",
             }
           },
+          -- If you don't want to use these columns, you can set `enabled = false` for each of them individually
+          file_size = {
+            enabled = true,
+            required_width = 64, -- min width of window required to show this column
+          },
+          type = {
+            enabled = true,
+            required_width = 122, -- min width of window required to show this column
+          },
+          last_modified = {
+            enabled = true,
+            required_width = 88, -- min width of window required to show this column
+          },
+          created = {
+            enabled = true,
+            required_width = 110, -- min width of window required to show this column
+          },
         },
         -- A list of functions, each representing a global custom command
         -- that will be available in all sources (if not overridden in `opts[source_name].commands`)
@@ -252,6 +282,14 @@ use {
             ["?"] = "show_help",
             ["<"] = "prev_source",
             [">"] = "next_source",
+            ["i"] = "show_file_details",
+            ["o"] = { "show_help", nowait=false, config = { title = "Order by", prefix_key = "o" }},
+            ["oc"] = { "order_by_created", nowait = false },
+            ["od"] = { "order_by_diagnostics", nowait = false },
+            ["om"] = { "order_by_modified", nowait = false },
+            ["on"] = { "order_by_name", nowait = false },
+            ["os"] = { "order_by_size", nowait = false },
+            ["ot"] = { "order_by_type", nowait = false },
           }
         },
         nesting_rules = {},

doc/neo-tree.txt

@@ -270,6 +270,9 @@ A    = add_directory:        Create a new directory, in this mode it does not
 d    = delete:               Delete the selected file or directory.
                              Supports visual selection.~
 
+i    = show_file_details     Show file details in popup window, such as size
+                             and last modified date.
+
 r    = rename:               Rename the selected file or directory.
 
 y    = copy_to_clipboard:    Mark file to be copied.
@@ -290,11 +293,25 @@ m    = move:                 Move the selected file or directory.
 
 
 VIEW CHANGES                                            *neo-tree-view-changes*
-H = toggle_hidden: Toggle whether hidden (filtered items) are shown or not.
+H  = toggle_hidden:  Toggle whether hidden (filtered items) are shown or not.
+
+R  = refresh:        Rescan the filesystem and redraw the tree. Changes made 
+                     within nvim should be detected automatically, but this is
+                     useful for changes made elsewhere.
+
+o  = order_by...     Show help menu for order by choices.
+
+oc = ...created:     Sort the tree by created date.
+
+od = ...diagnostics: Sort by diagnostic severity.
+
+om = ...modified:    Sort by last modified date.
+
+om = ...name:        Sort by name (default sort).
+
+os = ...size:        Sort by size.
 
-R = refresh:       Rescan the filesystem and redraw the tree. Changes made 
-                   within nvim should be detected automatically, but this is
-                   useful for changes made elsewhere.
+ot = ...type:        Sort by type.
 
 
 FILTER                                                        *neo-tree-filter*
@@ -1230,6 +1247,8 @@ NeoTreeExpander           Used for collapsed/expanded icons.
 NeoTreeNormal             |hl-Normal| override in Neo-tree window.
 NeoTreeNormalNC           |hl-NormalNC| override in Neo-tree window.
 NeoTreeSignColumn         |hl-SignColumn| override in Neo-tree window.
+NeoTreeStats              Used for "stat" columns like size, last modified, etc.
+NeoTreeStatsHeader        Used for the header (top line) of the above columns.
 NeoTreeStatusLine         |hl-StatusLine| override in Neo-tree window.
 NeoTreeStatusLineNC       |hl-StatusLineNC| override in Neo-tree window.
 NeoTreeVertSplit          |hl-VertSplit| override in Neo-tree window.

lua/neo-tree/defaults.lua

@@ -234,6 +234,23 @@ local config = {
       },
       align = "right",
     },
+    -- If you don't want to use these columns, you can set `enabled = false` for each of them individually
+    file_size = {
+      enabled = true,
+      required_width = 64, -- min width of window required to show this column
+    },
+    type = {
+      enabled = true,
+      required_width = 122, -- min width of window required to show this column
+    },
+    last_modified = {
+      enabled = true,
+      required_width = 88, -- min width of window required to show this column
+    },
+    created = {
+      enabled = true,
+      required_width = 110, -- min width of window required to show this column
+    },
   },
   renderers = {
     directory = {
@@ -251,7 +268,11 @@ local config = {
           -- },
           { "clipboard", zindex = 10 },
           { "diagnostics", errors_only = true, zindex = 20, align = "right", hide_when_expanded = true },
-          { "git_status", zindex = 20, align = "right", hide_when_expanded = true },
+          { "git_status", zindex = 10, align = "right", hide_when_expanded = true },
+          { "file_size", zindex = 10, align = "right" },
+          { "type", zindex = 10, align = "right" },
+          { "last_modified", zindex = 10, align = "right" },
+          { "created", zindex = 10, align = "right" },
         },
       },
     },
@@ -274,7 +295,11 @@ local config = {
           { "bufnr", zindex = 10 },
           { "modified", zindex = 20, align = "right" },
           { "diagnostics",  zindex = 20, align = "right" },
-          { "git_status", zindex = 20, align = "right" },
+          { "git_status", zindex = 10, align = "right" },
+          { "file_size", zindex = 10, align = "right" },
+          { "type", zindex = 10, align = "right" },
+          { "last_modified", zindex = 10, align = "right" },
+          { "created", zindex = 10, align = "right" },
         },
       },
     },
@@ -372,6 +397,14 @@ local config = {
       ["?"] = "show_help",
       ["<"] = "prev_source",
       [">"] = "next_source",
+      ["i"] = "show_file_details",
+      ["o"] = { "show_help", nowait=false, config = { title = "Order by", prefix_key = "o" }},
+      ["oc"] = { "order_by_created", nowait = false },
+      ["od"] = { "order_by_diagnostics", nowait = false },
+      ["om"] = { "order_by_modified", nowait = false },
+      ["on"] = { "order_by_name", nowait = false },
+      ["os"] = { "order_by_size", nowait = false },
+      ["ot"] = { "order_by_type", nowait = false },
     },
   },
   filesystem = {

lua/neo-tree/sources/buffers/lib/items.lua

@@ -100,7 +100,7 @@ M.get_opened_buffers = function(state)
   for id, _ in pairs(context.folders) do
     table.insert(state.default_expanded_nodes, id)
   end
-  file_items.deep_sort(root.children)
+  file_items.advanced_sort(root.children, state)
   renderer.show_nodes(root_folders, state)
   state.loading = false
 end

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

@@ -407,10 +407,133 @@ M.prev_source = function(state)
   })
 end
 
+local function set_sort(state, label)
+  local sort = state.sort or { label = "Name", direction = -1}
+  if sort.label == label then
+    sort.direction = sort.direction * -1
+  else
+    sort.label = label
+    sort.direction = -1
+  end
+  state.sort = sort
+end
+
+M.order_by_created = function (state)
+  set_sort(state, "Created")
+  state.sort_field_provider = function (node)
+    local stat = utils.get_stat(node)
+    return stat.birthtime and stat.birthtime.sec or 0
+  end
+  require("neo-tree.sources.manager").refresh(state.name)
+end
+
+M.order_by_modified = function (state)
+  set_sort(state, "Last Modified")
+  state.sort_field_provider = function (node)
+    local stat = utils.get_stat(node)
+    return stat.mtime and stat.mtime.sec or 0
+  end
+  require("neo-tree.sources.manager").refresh(state.name)
+end
+
+M.order_by_name = function (state)
+  set_sort(state, "Name")
+  state.sort_field_provider = nil
+  require("neo-tree.sources.manager").refresh(state.name)
+end
+
+M.order_by_size = function (state)
+  set_sort(state, "Size")
+  state.sort_field_provider = function (node)
+    local stat = utils.get_stat(node)
+    return stat.size or 0
+  end
+  require("neo-tree.sources.manager").refresh(state.name)
+end
+
+M.order_by_type = function (state)
+  set_sort(state, "Type")
+  state.sort_field_provider = function (node)
+    return node.ext or node.type
+  end
+  require("neo-tree.sources.manager").refresh(state.name)
+end
+
+M.order_by_git_status = function (state)
+  set_sort(state, "Git Status")
+
+  state.sort_field_provider = function (node)
+    local git_status_lookup = state.git_status_lookup or {}
+    local git_status = git_status_lookup[node.path]
+    if git_status then
+      return git_status
+    end
+
+    if node.filtered_by and node.filtered_by.gitignored then
+       return "!!"
+    else
+      return ""
+    end
+  end
+
+  require("neo-tree.sources.manager").refresh(state.name)
+end
+
+M.order_by_diagnostics = function (state)
+  set_sort(state, "Diagnostics")
+
+  state.sort_field_provider = function (node)
+    local diag = state.diagnostics_lookup or {}
+    local diagnostics = diag[node.path]
+    if not diagnostics then
+      return 0
+    end
+    if not diagnostics.severity_number then
+      return 0
+    end
+    -- lower severity number means higher severity
+    return 5 - diagnostics.severity_number
+  end
+
+  require("neo-tree.sources.manager").refresh(state.name)
+end
+
 M.show_debug_info = function(state)
   print(vim.inspect(state))
 end
 
+M.show_file_details = function (state)
+  local node = state.tree:get_node()
+  if node.type == "message" then
+    return
+  end
+  local stat = utils.get_stat(node)
+  local left = {}
+  local right = {}
+  table.insert(left, "Name")
+  table.insert(right, node.name)
+  table.insert(left, "Path")
+  table.insert(right, node:get_id())
+  table.insert(left, "Type")
+  table.insert(right, node.type)
+  if stat.size then
+    table.insert(left, "Size")
+    table.insert(right, utils.filesize(stat.size))
+    table.insert(left, "Created")
+    table.insert(right, os.date("%Y-%m-%d %I:%M %p", stat.birthtime.sec))
+    table.insert(left, "Modified")
+    table.insert(right, os.date("%Y-%m-%d %I:%M %p", stat.mtime.sec))
+  end
+
+  local lines = {}
+  for i, v in ipairs(left) do
+    local line = string.format("%9s: %s", v, right[i])
+    table.insert(lines, line)
+  end
+
+  popups.alert("File Details", lines)
+end
+
 ---Pastes all items from the clipboard to the current directory.
 ---@param state table The state of the source
 ---@param callback function The callback to call when the command is done. Called with the parent node as the argument.
@@ -737,7 +860,9 @@ M.vsplit_with_window_picker = function(state, toggle_directory)
 end
 
 M.show_help = function(state)
-  help.show(state)
+  local title = state.config and state.config.title or nil
+  local prefix_key = state.config and state.config.prefix_key or nil
+  help.show(state, title, prefix_key)
 end
 
 return M