feat: allow specifying mapping_options once for all mappings, part of #242

Author: cseickel

README.md

@@ -144,8 +144,15 @@ use {
         window = {
           position = "left",
           width = 40,
+          mapping_options = {
+            noremap = true,
+            nowait = true,
+          },
           mappings = {
-            ["<space>"] = "toggle_node",
+            ["<space>"] = { 
+                "toggle_node", 
+                nowait = false, -- disable `nowait` if you have existing combos starting with this char that you want to use 
+            },
             ["<2-LeftMouse>"] = "open",
             ["<cr>"] = "open",
             ["S"] = "open_split",

doc/neo-tree.txt

@@ -319,8 +319,10 @@ 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.
+set this for all mappings using the `mapping_options` key, or on individual
+mappings by specifiying them as a table that consists of the command and any
+options you want to use. If both are specified, the mapping merges with and
+overrides the global `mapping_options`
 
 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
@@ -329,6 +331,10 @@ assigning it to the `command` key:
    require("neo-tree").setup({
      filesystem = {
        window = {
+         mapping_options = {
+            noremap = true,
+            nowait = false,
+         },
          mappings = {
            ["?"] = {
              function(state)

lua/neo-tree/ui/renderer.lua

@@ -644,12 +644,13 @@ create_window = function(state)
     ["noop"] = true,
   }
   local mappings = utils.get_value(state, "window.mappings", {}, true)
+  local mapping_options = utils.get_value(state, "window.mapping_options", { noremap = true }, 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 }
+        local map_options = vim.deepcopy(mapping_options)
         if type(func) == "table" then
           for key, value in pairs(func) do
             if key ~= "command" and key ~= 1 then