feat: add toggle_node command, open command no longer expands nested files, closes #201

Author: cseickel

README.md

@@ -119,6 +119,7 @@ use {
           position = "left",
           width = 40,
           mappings = {
+            ["<space>"] = "toggle_node",
             ["<2-LeftMouse>"] = "open",
             ["<cr>"] = "open",
             ["S"] = "open_split",

doc/neo-tree.txt

@@ -146,6 +146,9 @@ are defined by default.
 
 Note: The "selected" item is the line the cursor is currently on.
 
+<space>       = toggle_node  Expand or collapse a node with children, which
+                             may be a directory or a nested file.
+
 <2-LeftMouse> = open:        Expand or collapse a folder. If a file is selected,
                              open it in the window closest to the tree.
 
@@ -633,21 +636,24 @@ component:
 
 FILE NESTING                                             *neo-tree-file-nesting*
 
-By default, file nesting is disabled since `nesting_rules` table is empty,
-there is not files to apply the nesting, this can be enabled filling the
-`nesting_rules` table with the following structure:
+By default, file nesting is disabled since the `nesting_rules` table is empty.
+To enable this feature, fill in the `nesting_rules` table with the following
+structure:
 >
     require("neo-tree").setup({
         nesting_rules = {
-            ["js"] = { "js.map" }
+            ["js"] = { "js.map" },
         }
     })
 <
 This will render:
 >
     FILENAME.js
         FILENAME.js.map
+
 <
+The default mapping to expand/collapse nested files is <space>.
+
 
 HIGHLIGHTS                                                 *neo-tree-highlights*
 

lua/neo-tree/defaults.lua

@@ -107,6 +107,7 @@ local config = {
     -- Mappings for tree window. See `:h nep-tree-mappings` for a list of built-in commands.
     -- You can also create your own commands by providing a function instead of a string.
     mappings = {
+      ["<space>"] = "toggle_node",
       ["<2-LeftMouse>"] = "open",
       ["<cr>"] = "open",
       ["S"] = "open_split",

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

@@ -72,4 +72,6 @@ M.set_root = function(state)
   end
 end
 
+M.toggle_node = cc.toggle_node
+
 return M

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

@@ -181,19 +181,10 @@ local open_with_cmd = function(state, open_cmd, toggle_directory)
     return
   end
 
-  local function open()
-    local path = node:get_id()
-    utils.open_file(state, path, open_cmd)
-  end
-
-  if utils.is_expandable(node) then
-    if toggle_directory and node.type == "directory" then
+  if node.type == "directory" then
+    if toggle_directory then
       toggle_directory(node)
     elseif node:has_children() then
-      if node:is_expanded() and node.type == "file" then
-        return open()
-      end
-
       local updated = false
       if node:is_expanded() then
         updated = node:collapse()
@@ -205,7 +196,8 @@ local open_with_cmd = function(state, open_cmd, toggle_directory)
       end
     end
   else
-    open()
+    local path = node:get_id()
+    utils.open_file(state, path, open_cmd)
   end
 end
 
@@ -240,10 +232,10 @@ M.rename = function(state, callback)
 end
 
 ---Expands or collapses the current node.
-M.toggle_directory = function(state)
+M.toggle_node = function(state)
   local tree = state.tree
   local node = tree:get_node()
-  if node.type ~= "directory" then
+  if not utils.is_expandable(node) then
     return
   end
   if node.loaded == false then
@@ -263,4 +255,14 @@ M.toggle_directory = function(state)
   end
 end
 
+---Expands or collapses the current node.
+M.toggle_directory = function(state)
+  local tree = state.tree
+  local node = tree:get_node()
+  if node.type ~= "directory" then
+    return
+  end
+  M.toggle_node(state)
+end
+
 return M

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

@@ -123,4 +123,6 @@ M.toggle_gitignore = function(state)
   M.toggle_hidden(state)
 end
 
+M.toggle_node = cc.toggle_node
+
 return M

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

@@ -129,4 +129,6 @@ M.rename = function(state)
   cc.rename(state, refresh)
 end
 
+M.toggle_node = cc.toggle_node
+
 return M