feat: async rename and create file

Author: yioneko

doc/nvim-tree-lua.txt

@@ -64,7 +64,7 @@ Requirements
 ==============================================================================
  2. QUICK START                                         *nvim-tree-quickstart*
 
-Setup should be run in a lua file or in a |lua-heredoc| if using in a vim file.
+Setup should be run in a lua file or in a |lua-heredoc| if using in a vim file. >lua
 
     -- examples for your init.lua
 
@@ -169,7 +169,7 @@ setup() function takes one optional argument: configuration table. If omitted
 nvim-tree will be initialised with default configuration.
 
 Subsequent calls to setup will replace the previous configuration.
->
+>lua
     require("nvim-tree").setup { -- BEGIN_DEFAULT_OPTS
       auto_reload_on_write = true,
       disable_netrw = false,
@@ -394,6 +394,12 @@ Subsequent calls to setup will replace the previous configuration.
           watcher = false,
         },
       },
+      experimental = {
+        async = {
+          create_file = false,
+          rename_file = false,
+        }
+      }
     } -- END_DEFAULT_OPTS
 <
 
@@ -405,7 +411,7 @@ Completely disable netrw
 
 It is strongly advised to eagerly disable netrw, due to race conditions at vim
 startup.
-Set the following at the very beginning of your `init.lua` / `init.vim`: >
+Set the following at the very beginning of your `init.lua` / `init.vim`: >lua
     vim.g.loaded_netrw = 1
     vim.g.loaded_netrwPlugin = 1
 <
@@ -452,7 +458,7 @@ function.
   - `name`:          `string`
   - `type`:          `"directory"` | `"file"` | `"link"`
 
-  Example: sort by name length: >
+  Example: sort by name length: >lua
     local sort_by = function(nodes)
       table.sort(nodes, function(a, b)
         return #a.name < #b.name
@@ -646,7 +652,7 @@ 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.
     Type: `function(bufnr)`, Default: `"disable"`
-    e.g. >
+    e.g. >lua
       local api = require("nvim-tree.api")
 
       local function on_attach(bufnr)
@@ -780,7 +786,7 @@ UI rendering setup
       Type: `string` or `function(root_cwd)`, Default: `":~:s?$?/..?"`
 
       Function is passed the absolute path of the root folder and should return a string.
-      e.g. >
+      e.g. >lua
         my_root_folder_label = function(path)
           return ".../" .. vim.fn.fnamemodify(path, ":t")
         end
@@ -1012,7 +1018,7 @@ Configuration for various actions.
             The function should return the window id that will open the node,
             or `nil` if an invalid window is picked or user cancelled the action.
               Type: `string` | `function`, Default: `"default"`
-              e.g. s1n7ax/nvim-window-picker plugin: >
+              e.g. s1n7ax/nvim-window-picker plugin: >lua
                 window_picker = {
                   enable = true,
                   picker = require('window-picker').pick_window,
@@ -1134,6 +1140,21 @@ Configuration for diagnostic logging.
         |nvim-tree.filesystem_watchers| processing, verbose.
           Type: `boolean`, Default: `false`
 
+*nvim-tree.experimental*
+Configuration for experimental features.
+
+    *nvim-tree.experimental.async*
+    Control experimental async behavior.
+
+        *nvim-tree.experimental.async.create_file*
+        Toggle async behavior of create file operation.
+          Type: `boolean`, Default: `false`
+
+        *nvim-tree.experimental.async.rename_file*
+        Toggle async behavior of rename file operation. Note this also
+        influence bulk move action.
+          Type: `boolean`, Default: `false`
+
 ==============================================================================
  4.1 VINEGAR STYLE                                         *nvim-tree-vinegar*
 
@@ -1144,8 +1165,8 @@ it in a specific way:
 
 - Use `require"nvim-tree".open_replacing_current_buffer()` instead of the
 default open command.
-You can easily implement a toggle using this too:
->
+You can easily implement a toggle using this too: >lua
+
     local function toggle_replace()
       local view = require"nvim-tree.view"
       local api = require"nvim-tree.api"
@@ -1157,8 +1178,8 @@ You can easily implement a toggle using this too:
     end
 <
 - Use the `edit_in_place` action to edit files. It's bound to `<C-e>` by
-default, vinegar uses `<CR>`. You can override this with:
->
+default, vinegar uses `<CR>`. You can override this with: >lua
+
     require"nvim-tree".setup {
       view = {
         mappings = {
@@ -1179,8 +1200,8 @@ A good functionality to enable is |nvim-tree.hijack_directories|.
  5. API                                                   *nvim-tree-api*
 
 Nvim-tree's public API can be used to access features.
->
-e.g. >
+
+e.g. >lua
     local api = require("nvim-tree.api")
     api.tree.toggle()
 <
@@ -1262,6 +1283,10 @@ exists.
 - api.events:                                           *nvim-tree.api.events*
     - subscribe `(eventType: Event, callback: function(...args))`
     - Event (enum type, please see |nvim_tree_events_kind|)
+    - subscribe_async `(eventType: Event, callback: function(...args))`
+      Same as `subscribe`, except the callback could be async. The async
+      callback will be called in the same context as the event. See also
+      *nvim-tree.api.async*.
 
 - api.live_filter:                                      *nvim-tree.api.live_filter*
     - start
@@ -1277,6 +1302,10 @@ exists.
     - navigate.prev
     - navigate.select
 
+- api.async:                                            *nvim-tree.api.async*
+    - call `(func: function, ...args)`
+    - in_async
+
 ==============================================================================
  6. MAPPINGS                                              *nvim-tree-mappings*
 
@@ -1300,7 +1329,7 @@ Setting your own mapping in the configuration will soon be deprecated, see
               Default `'n'`.
 
 Examples:
->
+>lua
     local function print_node_path(node)
       print(node.absolute_path)
     end
@@ -1382,7 +1411,7 @@ DEFAULT MAPPINGS                                     *nvim-tree-default-mappings
 `m`               toggle_mark         Toggle node in bookmarks
 `bmv`             bulk_move           Move all bookmarked nodes into specified location
 
->
+>lua
   view.mappings.list = { -- BEGIN_DEFAULT_MAPPINGS
     { key = { "<CR>", "o", "<2-LeftMouse>" }, action = "edit" },
     { key = "<C-e>",                          action = "edit_in_place" },
@@ -1444,7 +1473,7 @@ All the following highlight groups can be configured by hand. Aside from
 groups.
 
 Example (in your `init.vim`):
->
+>vim
     highlight NvimTreeSymlink guifg=blue gui=bold,underline
 <
 You should have 'termguicolors' enabled, otherwise, colors will not be
@@ -1534,7 +1563,7 @@ to |nvim_tree_registering_handlers| for more information.
 Handlers are registered by calling |nvim-tree-api| `events.subscribe`
 function with an `events.Event` kind.
 
-e.g. handler for node renamed: >
+e.g. handler for node renamed: >lua
     local api = require("nvim-tree.api")
     local Event = api.events.Event
 
@@ -1595,12 +1624,12 @@ To get the list of marked paths, you can call
 Navigation for marks is not bound by default in nvim-tree because we don't
 want to focus the tree view each time we wish to switch to another mark.
 
-This requires binding bookmark navigation yourself.
-
--- in your lua configuration
-vim.keymap.set("n", "<leader>mn", require("nvim-tree.api").marks.navigate.next)
-vim.keymap.set("n", "<leader>mp", require("nvim-tree.api").marks.navigate.prev)
-vim.keymap.set("n", "<leader>ms", require("nvim-tree.api").marks.navigate.select)
+This requires binding bookmark navigation yourself. >lua
+    -- in your lua configuration
+    vim.keymap.set("n", "<leader>mn", require("nvim-tree.api").marks.navigate.next)
+    vim.keymap.set("n", "<leader>mp", require("nvim-tree.api").marks.navigate.prev)
+    vim.keymap.set("n", "<leader>ms", require("nvim-tree.api").marks.navigate.select)
+<
 
 ==============================================================================
  10. OS SPECIFIC RESTRICTIONS                          *nvim-tree-os-specific*

lua/nvim-tree.lua

@@ -702,6 +702,12 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
       watcher = false,
     },
   },
+  experimental = {
+    async = {
+      create_file = false,
+      rename_file = false,
+    },
+  },
 } -- END_DEFAULT_OPTS
 
 local function merge_options(conf)

lua/nvim-tree/actions/fs/create-file.lua

@@ -5,16 +5,28 @@ local core = require "nvim-tree.core"
 local notify = require "nvim-tree.notify"
 
 local find_file = require("nvim-tree.actions.finders.find-file").fn
+local async = require "nvim-tree.async"
 
 local M = {}
 
+---@async
 local function create_and_notify(file)
-  local ok, fd = pcall(vim.loop.fs_open, file, "w", 420)
-  if not ok then
+  local fd, err
+  if M.enable_async then
+    err, fd = async.call(vim.loop.fs_open, file, "w", 420)
+  else
+    fd, err = vim.loop.fs_open(file, "w", 420)
+  end
+  if err then
     notify.error("Couldn't create file " .. file)
     return
   end
-  vim.loop.fs_close(fd)
+  if M.enable_async then
+    async.call(vim.loop.fs_close, fd)
+    async.schedule()
+  else
+    vim.loop.fs_close(fd)
+  end
   events._dispatch_file_created(file)
 end
 
@@ -49,7 +61,62 @@ local function get_containing_folder(node)
   return node.absolute_path:sub(0, -node_name_size - 1)
 end
 
-function M.fn(node)
+---@async
+local async_fn = async.wrap(function(node)
+  local containing_folder = get_containing_folder(node)
+
+  local input_opts = { prompt = "Create file ", default = containing_folder, completion = "file" }
+
+  local new_file_path = async.call(vim.ui.input, input_opts)
+  utils.clear_prompt()
+  if not new_file_path or new_file_path == containing_folder then
+    return
+  end
+
+  if utils.file_exists(new_file_path) then
+    notify.warn "Cannot create: file already exists"
+    return
+  end
+
+  -- create a folder for each path element if the folder does not exist
+  -- if the answer ends with a /, create a file for the last path element
+  local is_last_path_file = not new_file_path:match(utils.path_separator .. "$")
+  local path_to_create = ""
+  local idx = 0
+
+  local num_nodes = get_num_nodes(utils.path_split(utils.path_remove_trailing(new_file_path)))
+  local is_error = false
+  for path in utils.path_split(new_file_path) do
+    idx = idx + 1
+    local p = utils.path_remove_trailing(path)
+    async.schedule()
+    if #path_to_create == 0 and vim.fn.has "win32" == 1 then
+      path_to_create = utils.path_join { p, path_to_create }
+    else
+      path_to_create = utils.path_join { path_to_create, p }
+    end
+    if is_last_path_file and idx == num_nodes then
+      create_file(path_to_create)
+    elseif not utils.file_exists(path_to_create) then
+      local err = async.call(vim.loop.fs_mkdir, path_to_create, 493)
+      if err then
+        notify.error("Could not create folder " .. path_to_create .. " :" .. err)
+        is_error = true
+        break
+      end
+      async.schedule()
+      events._dispatch_folder_created(new_file_path)
+    end
+  end
+  if not is_error then
+    notify.info(new_file_path .. " was properly created")
+  end
+
+  -- synchronously refreshes as we can't wait for the watchers
+  find_file(utils.path_remove_trailing(new_file_path))
+end, 1)
+
+function M.fn(node, cb)
   node = node and lib.get_last_group_node(node)
   if not node or node.name == ".." then
     node = {
@@ -59,6 +126,10 @@ function M.fn(node)
     }
   end
 
+  if M.enable_async then
+    return async_fn(node, cb)
+  end
+
   local containing_folder = get_containing_folder(node)
 
   local input_opts = { prompt = "Create file ", default = containing_folder, completion = "file" }
@@ -113,6 +184,7 @@ end
 
 function M.setup(opts)
   M.enable_reload = not opts.filesystem_watchers.enable
+  M.enable_async = opts.experimental.async.create_file
 end
 
 return M