feat(files): add command to close current node, closes #19

Author: cseickel

README.md

@@ -7,19 +7,46 @@ structures in a sidebar **or** floating window.
 
 Example for packer:
 ```lua
-    use {
-        "nvim-neo-tree/neo-tree.nvim",
-        branch = "v1.x",
-        requires = { 
-          "nvim-lua/plenary.nvim",
-          "kyazdani42/nvim-web-devicons", -- not strictly required, but recommended
-          "MunifTanjim/nui.nvim" 
-        },
-        config = function ()
-            require("neo-tree").setup()
-            vim.cmd([[nnoremap \ :NeoTreeReveal<cr>]])
-        end
-    }
+use {
+  "nvim-neo-tree/neo-tree.nvim",
+    branch = "v1.x",
+    requires = { 
+      "nvim-lua/plenary.nvim",
+      "kyazdani42/nvim-web-devicons", -- not strictly required, but recommended
+        "MunifTanjim/nui.nvim" 
+    },
+    config = function ()
+      require("neo-tree").setup({
+          popup_border_style = "rounded",
+          filesystem = {
+            window = {
+              mappings = {
+                ["<2-LeftMouse>"] = "open",
+                ["<cr>"] = "open",
+                ["S"] = "open_split",
+                ["s"] = "open_vsplit",
+                ["C"] = "close_node",
+                ["<bs>"] = "navigate_up",
+                ["."] = "set_root",
+                ["H"] = "toggle_hidden",
+                ["I"] = "toggle_gitignore",
+                ["R"] = "refresh",
+                ["/"] = "filter_as_you_type",
+                ["f"] = "filter_on_submit",
+                ["<c-x>"] = "clear_filter",
+                ["a"] = "add",
+                ["d"] = "delete",
+                ["r"] = "rename",
+                ["c"] = "copy_to_clipboard",
+                ["x"] = "cut_to_clipboard",
+                ["p"] = "paste_from_clipboard",
+              }
+            }
+          }
+      })
+  vim.cmd([[nnoremap \ :NeoTreeReveal<cr>]])
+    end
+}
 ```
 
 Here are the various ways to open the tree:

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

@@ -11,6 +11,8 @@ M.add = function(state)
   cc.add(state, buffers.refresh)
 end
 
+M.close_node = cc.close_node
+
 ---Marks node as copied, so that it can be pasted somewhere else.
 M.copy_to_clipboard = function(state)
   cc.copy_to_clipboard(state, buffers.redraw)

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

@@ -3,6 +3,7 @@
 local vim = vim
 local fs_actions = require('neo-tree.sources.filesystem.lib.fs_actions')
 local utils = require('neo-tree.utils')
+local renderer = require('neo-tree.ui.renderer')
 
 local M = {}
 
@@ -22,6 +23,17 @@ M.add = function(state, callback)
   end)
 end
 
+M.close_node = function(state, callback)
+  local tree = state.tree
+  local node = tree:get_node()
+  node = tree:get_node(node:get_parent_id())
+  if node then
+    node:collapse()
+    tree:render()
+    renderer.focus_node(state, node:get_id())
+  end
+end
+
 ---Marks node as copied, so that it can be pasted somewhere else.
 M.copy_to_clipboard = function(state, callback)
   local node = state.tree:get_node()

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

@@ -17,6 +17,8 @@ M.clear_filter = function(state)
   fs.reset_search(true)
 end
 
+M.close_node = cc.close_node
+
 ---Marks node as copied, so that it can be pasted somewhere else.
 M.copy_to_clipboard = function(state)
   cc.copy_to_clipboard(state, fs.redraw)

lua/neo-tree/sources/filesystem/defaults.lua

@@ -26,6 +26,7 @@ local filesystem = {
       ["<cr>"] = "open",
       ["S"] = "open_split",
       ["s"] = "open_vsplit",
+      ["C"] = "close_node",
       ["<bs>"] = "navigate_up",
       ["."] = "set_root",
       ["H"] = "toggle_hidden",

lua/neo-tree/sources/filesystem/init.lua

@@ -46,58 +46,6 @@ local get_path_to_reveal = function()
   return path
 end
 
-local reveal_file = function(state, path)
-  if not path then
-    return nil
-  end
-  local tree = state.tree
-  if not tree then
-    return false
-  end
-  local node = tree:get_node(path)
-  if not node then
-    return false
-  end
-  --expand_to_root(tree, node)
-  --tree:render()
-
-  local bufnr = utils.get_value(state, "bufnr", 0, true)
-  if bufnr == 0 then
-    return false
-  end
-  if not vim.api.nvim_buf_is_valid(bufnr) then
-    return false
-  end
-  local lines = vim.api.nvim_buf_line_count(state.bufnr)
-  local linenr = 0
-  while linenr < lines do
-    linenr = linenr + 1
-    node = tree:get_node(linenr)
-    if node then
-      if node:get_id() == path then
-        local col = 0
-        if node.indent then
-          col = string.len(node.indent)
-        end
-        if renderer.window_exists(state) then
-          vim.api.nvim_set_current_win(state.winid)
-        else
-          renderer.draw(state.tree:get_nodes(), state, nil)
-        end
-          local success, err = pcall(vim.api.nvim_win_set_cursor, state.winid, { linenr, col })
-          if not success then
-            print("Failed to set cursor: " .. err)
-          end
-          return success
-      end
-    else
-      --must be out of nodes
-      return false
-    end
-  end
-  return false
-end
-
 M.close = function()
   local state = get_state()
   renderer.close(state)
@@ -157,7 +105,7 @@ M.navigate = function(path, path_to_reveal, callback)
 
   if path_to_reveal then
     fs_scan.get_items_async(state, nil, path_to_reveal, function()
-      local found = reveal_file(state, path_to_reveal)
+      local found = renderer.focus_node(state, path_to_reveal)
       if not found and was_float then
         -- I'm not realy sure why it is not focused when it is created...
         --vim.api.nvim_set_current_win(state.winid)
@@ -198,7 +146,7 @@ M.reveal_current_file = function()
     return
   end
   if path then
-    if not reveal_file(state, path) then
+    if not renderer.focus_node(state, path) then
       M.focus(path)
     end
   end

lua/neo-tree/ui/renderer.lua

@@ -117,6 +117,63 @@ local prepare_node = function(item, state)
     return line
 end
 
+---Sets the cursor at the specified node.
+---@param state table The current state of the source.
+---@param id string The id of the node to set the cursor at.
+---@return boolean boolean True if the node was found and focused, false
+---otherwise.
+M.focus_node = function(state, id)
+  if not id then
+    return nil
+  end
+  local tree = state.tree
+  if not tree then
+    return false
+  end
+  local node = tree:get_node(id)
+  if not node then
+    return false
+  end
+  --expand_to_root(tree, node)
+  --tree:render()
+
+  local bufnr = utils.get_value(state, "bufnr", 0, true)
+  if bufnr == 0 then
+    return false
+  end
+  if not vim.api.nvim_buf_is_valid(bufnr) then
+    return false
+  end
+  local lines = vim.api.nvim_buf_line_count(state.bufnr)
+  local linenr = 0
+  while linenr < lines do
+    linenr = linenr + 1
+    node = tree:get_node(linenr)
+    if node then
+      if node:get_id() == id then
+        local col = 0
+        if node.indent then
+          col = string.len(node.indent)
+        end
+        if M.window_exists(state) then
+          vim.api.nvim_set_current_win(state.winid)
+        else
+          M.draw(state.tree:get_nodes(), state, nil)
+        end
+          local success, err = pcall(vim.api.nvim_win_set_cursor, state.winid, { linenr, col })
+          if not success then
+            print("Failed to set cursor: " .. err)
+          end
+          return success
+      end
+    else
+      --must be out of nodes
+      return false
+    end
+  end
+  return false
+end
+
 M.get_expanded_nodes = function(tree)
   local node_ids = {}