feat(api): add api.config.mappings.default_on_attach (#2037)

doc/nvim-tree-lua.txt

@@ -1425,6 +1425,13 @@ api.tree.toggle_help()                       *nvim-tree.api.tree.toggle_help()*
     - navigate.prev
     - navigate.select
 
+                           *nvim-tree.api.config.mappings.default_on_attach()*
+api.config.mappings.default_on_attach({bufnr})
+    Set all |nvim-tree-mappings-default|. Call from your |nvim-tree.on_attach|
+
+    Parameters: ~
+      • {bufnr} (number) nvim-tree buffer number passed to |nvim-tree.on_attach|
+
 api.config.mappings.active()          *nvim-tree.api.config.mappings.active()*
     Deprecated: only functions when using legacy |nvim-tree.view.mappings|
     Retrieve a clone of the currently active mappings: defaults + user.
@@ -1490,67 +1497,80 @@ will be applied.
 
 You are encouraged to copy these to your own |nvim-tree.on_attach| function.
 >
-  local on_attach = function(bufnr)
+  local api = require('nvim-tree.api')
+
+  local function opts(desc)
+    return { desc = 'nvim-tree: ' .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
+  end
+
+  -- BEGIN_DEFAULT_ON_ATTACH
+  vim.keymap.set('n', '<C-]>', api.tree.change_root_to_node,          opts('CD'))
+  vim.keymap.set('n', '<C-e>', api.node.open.replace_tree_buffer,     opts('Open: In Place'))
+  vim.keymap.set('n', '<C-k>', api.node.show_info_popup,              opts('Info'))
+  vim.keymap.set('n', '<C-r>', api.fs.rename_sub,                     opts('Rename: Omit Filename'))
+  vim.keymap.set('n', '<C-t>', api.node.open.tab,                     opts('Open: New Tab'))
+  vim.keymap.set('n', '<C-v>', api.node.open.vertical,                opts('Open: Vertical Split'))
+  vim.keymap.set('n', '<C-x>', api.node.open.horizontal,              opts('Open: Horizontal Split'))
+  vim.keymap.set('n', '<BS>',  api.node.navigate.parent_close,        opts('Close Directory'))
+  vim.keymap.set('n', '<CR>',  api.node.open.edit,                    opts('Open'))
+  vim.keymap.set('n', '<Tab>', api.node.open.preview,                 opts('Open Preview'))
+  vim.keymap.set('n', '>',     api.node.navigate.sibling.next,        opts('Next Sibling'))
+  vim.keymap.set('n', '<',     api.node.navigate.sibling.prev,        opts('Previous Sibling'))
+  vim.keymap.set('n', '.',     api.node.run.cmd,                      opts('Run Command'))
+  vim.keymap.set('n', '-',     api.tree.change_root_to_parent,        opts('Up'))
+  vim.keymap.set('n', 'a',     api.fs.create,                         opts('Create'))
+  vim.keymap.set('n', 'bmv',   api.marks.bulk.move,                   opts('Move Bookmarked'))
+  vim.keymap.set('n', 'B',     api.tree.toggle_no_buffer_filter,      opts('Toggle No Buffer'))
+  vim.keymap.set('n', 'c',     api.fs.copy.node,                      opts('Copy'))
+  vim.keymap.set('n', 'C',     api.tree.toggle_git_clean_filter,      opts('Toggle Git Clean'))
+  vim.keymap.set('n', '[c',    api.node.navigate.git.prev,            opts('Prev Git'))
+  vim.keymap.set('n', ']c',    api.node.navigate.git.next,            opts('Next Git'))
+  vim.keymap.set('n', 'd',     api.fs.remove,                         opts('Delete'))
+  vim.keymap.set('n', 'D',     api.fs.trash,                          opts('Trash'))
+  vim.keymap.set('n', 'E',     api.tree.expand_all,                   opts('Expand All'))
+  vim.keymap.set('n', 'e',     api.fs.rename_basename,                opts('Rename: Basename'))
+  vim.keymap.set('n', ']e',    api.node.navigate.diagnostics.next,    opts('Next Diagnostic'))
+  vim.keymap.set('n', '[e',    api.node.navigate.diagnostics.prev,    opts('Prev Diagnostic'))
+  vim.keymap.set('n', 'F',     api.live_filter.clear,                 opts('Clean Filter'))
+  vim.keymap.set('n', 'f',     api.live_filter.start,                 opts('Filter'))
+  vim.keymap.set('n', 'g?',    api.tree.toggle_help,                  opts('Help'))
+  vim.keymap.set('n', 'gy',    api.fs.copy.absolute_path,             opts('Copy Absolute Path'))
+  vim.keymap.set('n', 'H',     api.tree.toggle_hidden_filter,         opts('Toggle Dotfiles'))
+  vim.keymap.set('n', 'I',     api.tree.toggle_gitignore_filter,      opts('Toggle Git Ignore'))
+  vim.keymap.set('n', 'J',     api.node.navigate.sibling.last,        opts('Last Sibling'))
+  vim.keymap.set('n', 'K',     api.node.navigate.sibling.first,       opts('First Sibling'))
+  vim.keymap.set('n', 'm',     api.marks.toggle,                      opts('Toggle Bookmark'))
+  vim.keymap.set('n', 'o',     api.node.open.edit,                    opts('Open'))
+  vim.keymap.set('n', 'O',     api.node.open.no_window_picker,        opts('Open: No Window Picker'))
+  vim.keymap.set('n', 'p',     api.fs.paste,                          opts('Paste'))
+  vim.keymap.set('n', 'P',     api.node.navigate.parent,              opts('Parent Directory'))
+  vim.keymap.set('n', 'q',     api.tree.close,                        opts('Close'))
+  vim.keymap.set('n', 'r',     api.fs.rename,                         opts('Rename'))
+  vim.keymap.set('n', 'R',     api.tree.reload,                       opts('Refresh'))
+  vim.keymap.set('n', 's',     api.node.run.system,                   opts('Run System'))
+  vim.keymap.set('n', 'S',     api.tree.search_node,                  opts('Search'))
+  vim.keymap.set('n', 'U',     api.tree.toggle_custom_filter,         opts('Toggle Hidden'))
+  vim.keymap.set('n', 'W',     api.tree.collapse_all,                 opts('Collapse'))
+  vim.keymap.set('n', 'x',     api.fs.cut,                            opts('Cut'))
+  vim.keymap.set('n', 'y',     api.fs.copy.filename,                  opts('Copy Name'))
+  vim.keymap.set('n', 'Y',     api.fs.copy.relative_path,             opts('Copy Relative Path'))
+  vim.keymap.set('n', '<2-LeftMouse>',  api.node.open.edit,           opts('Open'))
+  vim.keymap.set('n', '<2-RightMouse>', api.tree.change_root_to_node, opts('CD'))
+  -- END_DEFAULT_ON_ATTACH
+<
+Alternatively, you may apply these default mappings from your |nvim-tree.on_attach| via
+|nvim-tree.api.config.mappings.default_on_attach()| e.g.
+>
+  local function my_on_attach(bufnr)
     local api = require('nvim-tree.api')
 
-    -- BEGIN_DEFAULT_ON_ATTACH
+    local function opts(desc)
-    local opts = function(desc)
       return { desc = 'nvim-tree: ' .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
     end
 
-    vim.keymap.set('n', '<C-]>', api.tree.change_root_to_node,          opts('CD'))
+    api.config.mappings.default_on_attach(bufnr)
-    vim.keymap.set('n', '<C-e>', api.node.open.replace_tree_buffer,     opts('Open: In Place'))
+
-    vim.keymap.set('n', '<C-k>', api.node.show_info_popup,              opts('Info'))
+    -- your removals and mappings go here
-    vim.keymap.set('n', '<C-r>', api.fs.rename_sub,                     opts('Rename: Omit Filename'))
-    vim.keymap.set('n', '<C-t>', api.node.open.tab,                     opts('Open: New Tab'))
-    vim.keymap.set('n', '<C-v>', api.node.open.vertical,                opts('Open: Vertical Split'))
-    vim.keymap.set('n', '<C-x>', api.node.open.horizontal,              opts('Open: Horizontal Split'))
-    vim.keymap.set('n', '<BS>',  api.node.navigate.parent_close,        opts('Close Directory'))
-    vim.keymap.set('n', '<CR>',  api.node.open.edit,                    opts('Open'))
-    vim.keymap.set('n', '<Tab>', api.node.open.preview,                 opts('Open Preview'))
-    vim.keymap.set('n', '>',     api.node.navigate.sibling.next,        opts('Next Sibling'))
-    vim.keymap.set('n', '<',     api.node.navigate.sibling.prev,        opts('Previous Sibling'))
-    vim.keymap.set('n', '.',     api.node.run.cmd,                      opts('Run Command'))
-    vim.keymap.set('n', '-',     api.tree.change_root_to_parent,        opts('Up'))
-    vim.keymap.set('n', 'a',     api.fs.create,                         opts('Create'))
-    vim.keymap.set('n', 'bmv',   api.marks.bulk.move,                   opts('Move Bookmarked'))
-    vim.keymap.set('n', 'B',     api.tree.toggle_no_buffer_filter,      opts('Toggle No Buffer'))
-    vim.keymap.set('n', 'c',     api.fs.copy.node,                      opts('Copy'))
-    vim.keymap.set('n', 'C',     api.tree.toggle_git_clean_filter,      opts('Toggle Git Clean'))
-    vim.keymap.set('n', '[c',    api.node.navigate.git.prev,            opts('Prev Git'))
-    vim.keymap.set('n', ']c',    api.node.navigate.git.next,            opts('Next Git'))
-    vim.keymap.set('n', 'd',     api.fs.remove,                         opts('Delete'))
-    vim.keymap.set('n', 'D',     api.fs.trash,                          opts('Trash'))
-    vim.keymap.set('n', 'E',     api.tree.expand_all,                   opts('Expand All'))
-    vim.keymap.set('n', 'e',     api.fs.rename_basename,                opts('Rename: Basename'))
-    vim.keymap.set('n', ']e',    api.node.navigate.diagnostics.next,    opts('Next Diagnostic'))
-    vim.keymap.set('n', '[e',    api.node.navigate.diagnostics.prev,    opts('Prev Diagnostic'))
-    vim.keymap.set('n', 'F',     api.live_filter.clear,                 opts('Clean Filter'))
-    vim.keymap.set('n', 'f',     api.live_filter.start,                 opts('Filter'))
-    vim.keymap.set('n', 'g?',    api.tree.toggle_help,                  opts('Help'))
-    vim.keymap.set('n', 'gy',    api.fs.copy.absolute_path,             opts('Copy Absolute Path'))
-    vim.keymap.set('n', 'H',     api.tree.toggle_hidden_filter,         opts('Toggle Dotfiles'))
-    vim.keymap.set('n', 'I',     api.tree.toggle_gitignore_filter,      opts('Toggle Git Ignore'))
-    vim.keymap.set('n', 'J',     api.node.navigate.sibling.last,        opts('Last Sibling'))
-    vim.keymap.set('n', 'K',     api.node.navigate.sibling.first,       opts('First Sibling'))
-    vim.keymap.set('n', 'm',     api.marks.toggle,                      opts('Toggle Bookmark'))
-    vim.keymap.set('n', 'o',     api.node.open.edit,                    opts('Open'))
-    vim.keymap.set('n', 'O',     api.node.open.no_window_picker,        opts('Open: No Window Picker'))
-    vim.keymap.set('n', 'p',     api.fs.paste,                          opts('Paste'))
-    vim.keymap.set('n', 'P',     api.node.navigate.parent,              opts('Parent Directory'))
-    vim.keymap.set('n', 'q',     api.tree.close,                        opts('Close'))
-    vim.keymap.set('n', 'r',     api.fs.rename,                         opts('Rename'))
-    vim.keymap.set('n', 'R',     api.tree.reload,                       opts('Refresh'))
-    vim.keymap.set('n', 's',     api.node.run.system,                   opts('Run System'))
-    vim.keymap.set('n', 'S',     api.tree.search_node,                  opts('Search'))
-    vim.keymap.set('n', 'U',     api.tree.toggle_custom_filter,         opts('Toggle Hidden'))
-    vim.keymap.set('n', 'W',     api.tree.collapse_all,                 opts('Collapse'))
-    vim.keymap.set('n', 'x',     api.fs.cut,                            opts('Cut'))
-    vim.keymap.set('n', 'y',     api.fs.copy.filename,                  opts('Copy Name'))
-    vim.keymap.set('n', 'Y',     api.fs.copy.relative_path,             opts('Copy Relative Path'))
-    vim.keymap.set('n', '<2-LeftMouse>',  api.node.open.edit,           opts('Open'))
-    vim.keymap.set('n', '<2-RightMouse>', api.tree.change_root_to_node, opts('CD'))
-    -- END_DEFAULT_ON_ATTACH
   end
 <
 ==============================================================================

lua/nvim-tree/api.lua

@@ -170,6 +170,8 @@ Api.marks.navigate.next = require("nvim-tree.marks.navigation").next
 Api.marks.navigate.prev = require("nvim-tree.marks.navigation").prev
 Api.marks.navigate.select = require("nvim-tree.marks.navigation").select
 
+Api.config.mappings.default_on_attach = require("nvim-tree.keymap").default_on_attach
+
 Api.config.mappings.active = function()
   return require("nvim-tree.keymap-legacy").active_mappings_clone()
 end

lua/nvim-tree/keymap-legacy.lua

@@ -37,11 +37,10 @@ local BEGIN_ON_ATTACH = [[
 -- Please see https://github.com/nvim-tree/nvim-tree.lua/wiki/Migrating-To-on_attach for assistance in migrating.
 --
 
-local api = require('nvim-tree.api')
+local function on_attach(bufnr)
+  local api = require('nvim-tree.api')
 
-local on_attach = function(bufnr)
+  local function opts(desc)
-
-  local opts = function(desc)
     return { desc = 'nvim-tree: ' .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
   end
 ]]

lua/nvim-tree/keymap.lua

@@ -1,14 +1,14 @@
-local api = require "nvim-tree.api"
-
 local M = {}
 
 -- stylua: ignore start
 function M.default_on_attach(bufnr)
-  -- BEGIN_DEFAULT_ON_ATTACH
+  local api = require('nvim-tree.api')
-  local opts = function(desc)
+
+  local function opts(desc)
     return { desc = 'nvim-tree: ' .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
   end
 
+  -- BEGIN_DEFAULT_ON_ATTACH
   vim.keymap.set('n', '<C-]>', api.tree.change_root_to_node,          opts('CD'))
   vim.keymap.set('n', '<C-e>', api.node.open.replace_tree_buffer,     opts('Open: In Place'))
   vim.keymap.set('n', '<C-k>', api.node.show_info_popup,              opts('Info'))

scripts/update-help.sh

@@ -29,16 +29,13 @@ begin="BEGIN_DEFAULT_ON_ATTACH"
 end="END_DEFAULT_ON_ATTACH"
 
 # scrape DEFAULT_ON_ATTACH, indented at 2
-sed -n -e "/${begin}/,/${end}/{ /${begin}/d; /${end}/d; p; }" lua/nvim-tree/keymap.lua > /tmp/DEFAULT_ON_ATTACH.2.lua
+sed -n -e "/${begin}/,/${end}/{ /${begin}/d; /${end}/d; p; }" lua/nvim-tree/keymap.lua > /tmp/DEFAULT_ON_ATTACH.lua
 
-# indent some more
+# help
-sed -e "s/^  /    /" /tmp/DEFAULT_ON_ATTACH.2.lua > /tmp/DEFAULT_ON_ATTACH.4.lua
+sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/DEFAULT_ON_ATTACH.lua
-
-# help, indented at 4
-sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/DEFAULT_ON_ATTACH.4.lua
            }; /${end}/p; d; }" doc/nvim-tree-lua.txt
 
-# legacy keymap, indented at 2
+# legacy keymap
-sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/DEFAULT_ON_ATTACH.2.lua
+sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/DEFAULT_ON_ATTACH.lua
            }; /${end}/p; d; }" lua/nvim-tree/keymap-legacy.lua