chore(mappings): use default mappings when on_attach not present, log legacy migration

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -625,23 +625,22 @@ performance.
 *nvim-tree.on_attach*
 Function ran when creating the nvim-tree buffer.
 This can be used to attach keybindings to the tree buffer.
-When on_attach is "disabled", it will use the older mapping strategy, otherwise it
-will use the newer one.
->
-    on_attach = function(bufnr)
-        local inject_node = require("nvim-tree.utils").inject_node
-
-        vim.keymap.set("n", "<leader>n", inject_node(function(node)
-            if node then
-                print(node.absolute_path)
-            end
-        end), { buffer = bufnr, noremap = true })
+When on_attach is not a function, |nvim-tree.view.mappings| will be used.
+  Type: `function(bufnr)`, Default: `"disable"`
 
-        vim.bo[bufnr].path = "/tmp"
+  Example: >
+    local Api = require('nvim-tree.api')
+    local Lib = require('nvim-tree.lib')
+
+    local my_on_attach = function(bufnr)
+      vim.keymap.set('n', '?', Api.tree.toggle_help, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = 'Help' })
+      vim.keymap.set('n', 'h', Api.tree.toggle_help, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = 'Help' })
+      vim.keymap.set("n", "<C-P>", function()
+        local node = Lib.get_node_at_cursor()
+        print(node.absolute_path)
+      end, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = "my description" })
     end
 <
-    Type: `function(bufnr)`, Default: `"disable"`
-
 *nvim-tree.remove_keymaps*
 This can be used to remove the default mappings in the tree.
 - Remove specific keys by passing a `string` table of keys

lua/nvim-tree.lua

@@ -736,7 +736,6 @@ function M.setup(conf)
   validate_options(conf)
 
   local opts = merge_options(conf)
-  legacy.move_mappings_to_keymap(opts)
 
   local netrw_disabled = opts.disable_netrw or opts.hijack_netrw
   _config.root_dirs = opts.root_dirs
@@ -758,6 +757,8 @@ function M.setup(conf)
   log.line("config", "default config + user")
   log.raw("config", "%s\n", vim.inspect(opts))
 
+  legacy.move_mappings_to_keymap(opts)
+
   require("nvim-tree.actions").setup(opts)
   require("nvim-tree.keymap").setup(opts)
   require("nvim-tree.colors").setup()

lua/nvim-tree/legacy.lua

@@ -1,6 +1,7 @@
 local utils = require "nvim-tree.utils"
 local notify = require "nvim-tree.notify"
 local open_file = require "nvim-tree.actions.node.open-file"
+local log = require "nvim-tree.log"
 
 local DEFAULT_KEYMAPS = require("nvim-tree.keymap").DEFAULT_KEYMAPS
 
@@ -380,21 +381,25 @@ local on_attach = function(bufnr)
 ]]
 
   for _, el in pairs(call_list) do
+    local vim_keymap_set
     if el.action_cb then
-      M.on_attach_lua = string.format(
-        '%s  vim.keymap.set("n", "%s", function()\n    local node = Lib.get_node_at_cursor()\n    -- my code\n  end, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = "my description" })\n',
-        M.on_attach_lua,
+      vim_keymap_set = string.format(
+        'vim.keymap.set("n", "%s", function()\n    local node = Lib.get_node_at_cursor()\n    -- my code\n  end, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = "my description" })',
         el.key
       )
     elseif el.keymap then
-      M.on_attach_lua = string.format(
-        "%s  vim.keymap.set('n', '%s', %s, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = '%s' })\n",
-        M.on_attach_lua,
+      vim_keymap_set = string.format(
+        "vim.keymap.set('n', '%s', %s, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = '%s' })",
         el.key,
         LEGACY_CALLBACKS[el.keymap.legacy_action],
         el.keymap.desc.short
       )
     end
+
+    if vim_keymap_set then
+      log.line("config", "generated  %s", vim_keymap_set)
+      M.on_attach_lua = string.format("%s  %s\n", M.on_attach_lua, vim_keymap_set)
+    end
   end
   M.on_attach_lua = string.format("%send\n", M.on_attach_lua)
 
@@ -417,8 +422,9 @@ local on_attach = function(bufnr)
 end
 
 function M.move_mappings_to_keymap(opts)
-  if opts.on_attach == "disable" and opts.view and opts.view.mappings then
+  if type(opts.on_attach) ~= "function" and opts.view and opts.view.mappings then
     local custom_only, list = opts.view.mappings.custom_only, opts.view.mappings.list
+    log.line("config", "generating on_attach for %d legacy view.mappings.list:", #list)
     if custom_only then
       opts.remove_keymaps = true
       opts.view.mappings.custom_only = nil
@@ -469,7 +475,7 @@ function M.generate_on_attach()
     io.close(file)
     open_file.fn("edit", name)
   else
-    utils.notify.info "no custom mappings"
+    notify.info "no custom mappings"
   end
 end
 

lua/nvim-tree/view.lua

@@ -93,8 +93,8 @@ local function create_buffer(bufnr)
     vim.bo[M.get_bufnr()][option] = value
   end
 
+  require("nvim-tree.keymap").set_keymaps(M.get_bufnr())
   if type(M.on_attach) == "function" then
-    require("nvim-tree.keymap").set_keymaps(M.get_bufnr())
     M.on_attach(M.get_bufnr())
   end
 end