Feat branch complete on attach

README.md

@@ -30,6 +30,10 @@ Take a look at the [wiki](https://github.com/nvim-tree/nvim-tree.lua/wiki) for S
 
 Existing `*_on_setup*` mechanisms have been removed in favour of [Open At Startup](https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup)
 
+## New Mapping Method 2023-03-01
+
+[:help nvim-tree.view.mappings](doc/nvim-tree-lua.txt) have been deprecated in favour of [:help nvim-tree.on_attach](doc/nvim-tree-lua.txt). Please visit [Migrating To on_attach](https://github.com/nvim-tree/nvim-tree.lua/wiki/Migrating-To-on_attach) to transition.
+
 ## Requirements
 
 [neovim >=0.8.0](https://github.com/neovim/neovim/wiki/Installing-Neovim)
@@ -77,14 +81,6 @@ require("nvim-tree").setup()
 -- OR setup with some options
 require("nvim-tree").setup({
   sort_by = "case_sensitive",
-  view = {
-    width = 30,
-    mappings = {
-      list = {
-        { key = "u", action = "dir_up" },
-      },
-    },
-  },
   renderer = {
     group_empty = true,
   },
@@ -96,7 +92,7 @@ require("nvim-tree").setup({
 
 For complete list of available configuration options see [:help nvim-tree-setup](doc/nvim-tree-lua.txt)
 
-Each option is documented in `:help nvim-tree.OPTION_NAME`. Nested options can be accessed by appending `.`, for example [:help nvim-tree.view.mappings](doc/nvim-tree-lua.txt)
+Each option is documented in `:help nvim-tree.OPTION_NAME`. Nested options can be accessed by appending `.`, for example [:help nvim-tree.filters.dotfiles](doc/nvim-tree-lua.txt)
 
 ## Commands
 
@@ -114,10 +110,10 @@ Basic commands:
 
 ## Mappings
 
-nvim-tree comes with number of mappings; for default mappings please see [:help nvim-tree-default-mappings](doc/nvim-tree-lua.txt), for way of configuring mappings see [:help nvim-tree-mappings](doc/nvim-tree-lua.txt)
-
 `g?` toggles help, showing all the mappings and their actions.
 
+To customise your mappings see [:help nvim-tree.on_attach](doc/nvim-tree-lua.txt) and [:help nvim-tree-mappings](doc/nvim-tree-lua.txt)
+
 ## Roadmap
 
 nvim-tree is stable and new major features will not be added. The focus is on existing user experience.
@@ -133,25 +129,13 @@ Development is focused on:
 
 ## API
 
-nvim-tree exposes a public API. This is non breaking, with additions made as necessary.
+nvim-tree exposes a public API. This is non breaking, with additions made as necessary. See [:help nvim-tree-api](doc/nvim-tree-lua.txt)
 
 See wiki [Recipes](https://github.com/nvim-tree/nvim-tree.lua/wiki/Recipes) and [Tips](https://github.com/nvim-tree/nvim-tree.lua/wiki/Tips) for ideas and insipration.
 
 Please raise a [feature request](https://github.com/nvim-tree/nvim-tree.lua/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=) if the API is insufficent for your needs. [Contributions](#Contributing) are always welcome.
 
-[:help nvim-tree-api](doc/nvim-tree-lua.txt)
-
-### Events
-
-Users may subscribe to events that nvim-tree will dispatch in a variety of situations.
-
-[:help nvim-tree-events](doc/nvim-tree-lua.txt)
-
-### Actions
-
-Custom actions may be mapped which can invoke API or perform your own actions.
-
-[:help nvim-tree-mappings](doc/nvim-tree-lua.txt)
+You may also subscribe to events that nvim-tree will dispatch in a variety of situations, see [:help nvim-tree-events](doc/nvim-tree-lua.txt)
 
 ## Contributing
 

lua/nvim-tree.lua

@@ -14,6 +14,7 @@ local git = require "nvim-tree.git"
 local filters = require "nvim-tree.explorer.filters"
 local modified = require "nvim-tree.modified"
 local notify = require "nvim-tree.notify"
+local keymap_legacy = require "nvim-tree.keymap-legacy"
 
 local _config = {}
 
@@ -68,9 +69,6 @@ function M.change_root(filepath, bufnr)
   change_dir.fn(vim.fn.fnamemodify(filepath, ":p:h"))
 end
 
----@deprecated
-M.on_keypress = require("nvim-tree.actions.dispatch").dispatch
-
 function M.open_replacing_current_buffer(cwd)
   if view.is_visible() then
     return
@@ -379,6 +377,7 @@ local function setup_vim_commands()
   vim.api.nvim_create_user_command("NvimTreeCollapseKeepBuffers", function()
     collapse_all.fn(true)
   end, { bar = true })
+  vim.api.nvim_create_user_command("NvimTreeGenerateOnAttach", keymap_legacy.cmd_generate_on_attach, {})
 end
 
 function M.change_dir(name)
@@ -562,7 +561,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
   sync_root_with_cwd = false,
   reload_on_bufenter = false,
   respect_buf_cwd = false,
-  on_attach = "disable",
+  on_attach = "default",
   remove_keymaps = false,
   select_prompts = false,
   view = {
@@ -862,6 +861,7 @@ function M.setup(conf)
   validate_options(conf)
 
   local opts = merge_options(conf)
+
   local netrw_disabled = opts.disable_netrw or opts.hijack_netrw
 
   _config.root_dirs = opts.root_dirs
@@ -885,6 +885,8 @@ function M.setup(conf)
     log.raw("config", "%s\n", vim.inspect(opts))
   end
 
+  keymap_legacy.generate_legacy_on_attach(opts)
+
   require("nvim-tree.actions").setup(opts)
   require("nvim-tree.keymap").setup(opts)
   require("nvim-tree.colors").setup()