feat: allow specifying map-arguments in mappings, closes #242

Author: cseickel

doc/neo-tree.txt

@@ -311,6 +311,49 @@ You probably want #2:
      }
    })
 <
+CUSTOM MAPPINGS WITH ARGUMENTS
+
+If you want to include options for your mappings, such as `nowait`, you can
+map a key to a table that consists of the command and any options you want to
+use.
+
+The command can be either the string name of a built-in command, or a
+function, and is specified either as the first element in the table or by
+assigning it to the `command` key:
+>
+   require("neo-tree").setup({
+     filesystem = {
+       window = {
+         mappings = {
+           ["?"] = {
+             function(state)
+               local node = state.tree:get_node()
+               print(node.name)
+             end,
+             nowait = true
+           },
+           ["i"] = {
+             command = function(state)
+               local node = state.tree:get_node()
+               print(node.name)
+             end,
+             nowait = true
+           },
+           ["o"] = {
+             command = "open",
+             nowait = true
+           },
+           ["O"] = {
+             "open",
+             nowait = true
+           },
+         }
+       }
+     }
+   })
+<
+See |:map-arguments| for possible values to include. "buffer" and "nnoremap"
+are enabled by default.
 
 
 ================================================================================

lua/neo-tree/ui/renderer.lua

@@ -643,13 +643,21 @@ create_window = function(state)
     ["nop"] = true,
     ["noop"] = true,
   }
-  local map_options = { noremap = true }
   local mappings = utils.get_value(state, "window.mappings", {}, true)
   for cmd, func in pairs(mappings) do
     if utils.truthy(func) then
       if skip_this_mapping[func] then
         log.trace("Skipping mapping for %s", cmd)
       else
+        local map_options = { noremap = true }
+        if type(func) == "table" then
+          for key, value in pairs(func) do
+            if key ~= "command" and key ~= 1 then
+              map_options[key] = value
+            end
+          end
+          func = func.command or func[1]
+        end
         if type(func) == "string" then
           func = state.commands[func]
         end