Skip to content

Commit 27f5254

Browse files
UanelaUanela
committed
chore: update docs
1 parent 073fac1 commit 27f5254

5 files changed

Lines changed: 76 additions & 102 deletions

File tree

‎doc/nvim-tree-lua.txt‎

Lines changed: 73 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,6 @@ Show the mappings: `g?`
143143
`f` n Live Filter: Start |nvim_tree.api.filter.live.start()|
144144
`g?` n Help |nvim_tree.api.tree.toggle_help()|
145145
`gy` nx Copy Absolute Path |nvim_tree.api.fs.copy.absolute_path()|
146-
`bgy` nx Copy With Protocol |nvim_tree.api.fs.copy.absolute_path_with_protocol()|
147146
`ge` nx Copy Basename |nvim_tree.api.fs.copy.basename()|
148147
`H` n Toggle Filter: Dotfiles |nvim_tree.api.filter.dotfiles.toggle()|
149148
`I` n Toggle Filter: Git Ignored |nvim_tree.api.filter.git.ignored.toggle()|
@@ -155,7 +154,8 @@ Show the mappings: `g?`
155154
`o` n Open |nvim_tree.api.node.open.edit()|
156155
`O` n Open: No Window Picker |nvim_tree.api.node.open.no_window_picker()|
157156
`p` n Paste |nvim_tree.api.fs.paste()|
158-
`bgp` n Paste With Protocol |nvim_tree.api.fs.paste_with_protocol()|
157+
`gp` n Paste Using Register |nvim_tree.api.fs.paste_from_register_copying()|
158+
`gx` n Move Using Register |nvim_tree.api.fs.paste_from_register_cutting()|
159159
`P` n Parent Directory |nvim_tree.api.node.navigate.parent()|
160160
`q` n Close |nvim_tree.api.tree.close()|
161161
`r` n Rename |nvim_tree.api.fs.rename()|
@@ -404,67 +404,67 @@ You are encouraged to copy these to your {on_attach} function. >lua
404404
end
405405

406406
-- BEGIN_ON_ATTACH_DEFAULT
407-
vim.keymap.set("n", "<C-]>", api.tree.change_root_to_node, opts("CD"))
408-
vim.keymap.set("n", "<C-e>", api.node.open.replace_tree_buffer, opts("Open: In Place"))
409-
vim.keymap.set("n", "<C-k>", api.node.show_info_popup, opts("Info"))
410-
vim.keymap.set("n", "<C-r>", api.fs.rename_sub, opts("Rename: Omit Filename"))
411-
vim.keymap.set("n", "<C-t>", api.node.open.tab, opts("Open: New Tab"))
412-
vim.keymap.set("n", "<C-v>", api.node.open.vertical, opts("Open: Vertical Split"))
413-
vim.keymap.set("n", "<C-x>", api.node.open.horizontal, opts("Open: Horizontal Split"))
414-
vim.keymap.set("n", "<BS>", api.node.navigate.parent_close, opts("Close Directory"))
415-
vim.keymap.set("n", "<CR>", api.node.open.edit, opts("Open"))
416-
vim.keymap.set({ "n", "x" }, "<Del>", api.fs.remove, opts("Delete"))
417-
vim.keymap.set("n", "<Tab>", api.node.open.preview, opts("Open Preview"))
418-
vim.keymap.set("n", ">", api.node.navigate.sibling.next, opts("Next Sibling"))
419-
vim.keymap.set("n", "<", api.node.navigate.sibling.prev, opts("Previous Sibling"))
420-
vim.keymap.set("n", ".", api.node.run.cmd, opts("Run Command"))
421-
vim.keymap.set("n", "-", api.tree.change_root_to_parent, opts("Up"))
422-
vim.keymap.set("n", "a", api.fs.create, opts("Create File Or Directory"))
423-
vim.keymap.set("n", "bd", api.marks.bulk.delete, opts("Delete Bookmarked"))
424-
vim.keymap.set("n", "bt", api.marks.bulk.trash, opts("Trash Bookmarked"))
425-
vim.keymap.set("n", "bmv", api.marks.bulk.move, opts("Move Bookmarked"))
426-
vim.keymap.set("n", "B", api.filter.no_buffer.toggle, opts("Toggle Filter: No Buffer"))
427-
vim.keymap.set({ "n", "x" }, "c", api.fs.copy.node, opts("Copy"))
428-
vim.keymap.set("n", "C", api.filter.git.clean.toggle, opts("Toggle Filter: Git Clean"))
429-
vim.keymap.set("n", "[c", api.node.navigate.git.prev, opts("Prev Git"))
430-
vim.keymap.set("n", "]c", api.node.navigate.git.next, opts("Next Git"))
431-
vim.keymap.set({ "n", "x" }, "d", api.fs.remove, opts("Delete"))
432-
vim.keymap.set({ "n", "x" }, "D", api.fs.trash, opts("Trash"))
433-
vim.keymap.set("n", "E", api.tree.expand_all, opts("Expand All"))
434-
vim.keymap.set("n", "e", api.fs.rename_basename, opts("Rename: Basename"))
435-
vim.keymap.set("n", "]e", api.node.navigate.diagnostics.next, opts("Next Diagnostic"))
436-
vim.keymap.set("n", "[e", api.node.navigate.diagnostics.prev, opts("Prev Diagnostic"))
437-
vim.keymap.set("n", "F", api.filter.live.clear, opts("Live Filter: Clear"))
438-
vim.keymap.set("n", "f", api.filter.live.start, opts("Live Filter: Start"))
439-
vim.keymap.set("n", "g?", api.tree.toggle_help, opts("Help"))
440-
vim.keymap.set({ "n", "x" }, "gy", api.fs.copy.absolute_path, opts("Copy Absolute Path"))
441-
vim.keymap.set({ "n", "x" }, "bgy", api.fs.copy.absolute_path_with_protocol, opts("Copy With Protocol"))
442-
vim.keymap.set({ "n", "x" }, "ge", api.fs.copy.basename, opts("Copy Basename"))
443-
vim.keymap.set("n", "H", api.filter.dotfiles.toggle, opts("Toggle Filter: Dotfiles"))
444-
vim.keymap.set("n", "I", api.filter.git.ignored.toggle, opts("Toggle Filter: Git Ignored"))
445-
vim.keymap.set("n", "J", api.node.navigate.sibling.last, opts("Last Sibling"))
446-
vim.keymap.set("n", "K", api.node.navigate.sibling.first, opts("First Sibling"))
447-
vim.keymap.set("n", "L", api.node.open.toggle_group_empty, opts("Toggle Group Empty"))
448-
vim.keymap.set("n", "M", api.filter.no_bookmark.toggle, opts("Toggle Filter: No Bookmark"))
449-
vim.keymap.set({ "n", "x" }, "m", api.marks.toggle, opts("Toggle Bookmark"))
450-
vim.keymap.set("n", "o", api.node.open.edit, opts("Open"))
451-
vim.keymap.set("n", "O", api.node.open.no_window_picker, opts("Open: No Window Picker"))
452-
vim.keymap.set("n", "p", api.fs.paste, opts("Paste"))
453-
vim.keymap.set("n", "bgp", api.fs.paste_with_protocol, opts("Paste With Protocol"))
454-
vim.keymap.set("n", "P", api.node.navigate.parent, opts("Parent Directory"))
455-
vim.keymap.set("n", "q", api.tree.close, opts("Close"))
456-
vim.keymap.set("n", "r", api.fs.rename, opts("Rename"))
457-
vim.keymap.set("n", "R", api.tree.reload, opts("Refresh"))
458-
vim.keymap.set("n", "s", api.node.run.system, opts("Run System"))
459-
vim.keymap.set("n", "S", api.tree.search_node, opts("Search"))
460-
vim.keymap.set("n", "u", api.fs.rename_full, opts("Rename: Full Path"))
461-
vim.keymap.set("n", "U", api.filter.custom.toggle, opts("Toggle Filter: Custom"))
462-
vim.keymap.set("n", "W", api.tree.collapse_all, opts("Collapse All"))
463-
vim.keymap.set({ "n", "x" }, "x", api.fs.cut, opts("Cut"))
464-
vim.keymap.set("n", "y", api.fs.copy.filename, opts("Copy Name"))
465-
vim.keymap.set("n", "Y", api.fs.copy.relative_path, opts("Copy Relative Path"))
466-
vim.keymap.set("n", "<2-LeftMouse>", api.node.open.edit, opts("Open"))
467-
vim.keymap.set("n", "<2-RightMouse>", api.tree.change_root_to_node, opts("CD"))
407+
vim.keymap.set("n", "<C-]>", api.tree.change_root_to_node, opts("CD"))
408+
vim.keymap.set("n", "<C-e>", api.node.open.replace_tree_buffer, opts("Open: In Place"))
409+
vim.keymap.set("n", "<C-k>", api.node.show_info_popup, opts("Info"))
410+
vim.keymap.set("n", "<C-r>", api.fs.rename_sub, opts("Rename: Omit Filename"))
411+
vim.keymap.set("n", "<C-t>", api.node.open.tab, opts("Open: New Tab"))
412+
vim.keymap.set("n", "<C-v>", api.node.open.vertical, opts("Open: Vertical Split"))
413+
vim.keymap.set("n", "<C-x>", api.node.open.horizontal, opts("Open: Horizontal Split"))
414+
vim.keymap.set("n", "<BS>", api.node.navigate.parent_close, opts("Close Directory"))
415+
vim.keymap.set("n", "<CR>", api.node.open.edit, opts("Open"))
416+
vim.keymap.set({ "n", "x" }, "<Del>", api.fs.remove, opts("Delete"))
417+
vim.keymap.set("n", "<Tab>", api.node.open.preview, opts("Open Preview"))
418+
vim.keymap.set("n", ">", api.node.navigate.sibling.next, opts("Next Sibling"))
419+
vim.keymap.set("n", "<", api.node.navigate.sibling.prev, opts("Previous Sibling"))
420+
vim.keymap.set("n", ".", api.node.run.cmd, opts("Run Command"))
421+
vim.keymap.set("n", "-", api.tree.change_root_to_parent, opts("Up"))
422+
vim.keymap.set("n", "a", api.fs.create, opts("Create File Or Directory"))
423+
vim.keymap.set("n", "bd", api.marks.bulk.delete, opts("Delete Bookmarked"))
424+
vim.keymap.set("n", "bt", api.marks.bulk.trash, opts("Trash Bookmarked"))
425+
vim.keymap.set("n", "bmv", api.marks.bulk.move, opts("Move Bookmarked"))
426+
vim.keymap.set("n", "B", api.filter.no_buffer.toggle, opts("Toggle Filter: No Buffer"))
427+
vim.keymap.set({ "n", "x" }, "c", api.fs.copy.node, opts("Copy"))
428+
vim.keymap.set("n", "C", api.filter.git.clean.toggle, opts("Toggle Filter: Git Clean"))
429+
vim.keymap.set("n", "[c", api.node.navigate.git.prev, opts("Prev Git"))
430+
vim.keymap.set("n", "]c", api.node.navigate.git.next, opts("Next Git"))
431+
vim.keymap.set({ "n", "x" }, "d", api.fs.remove, opts("Delete"))
432+
vim.keymap.set({ "n", "x" }, "D", api.fs.trash, opts("Trash"))
433+
vim.keymap.set("n", "E", api.tree.expand_all, opts("Expand All"))
434+
vim.keymap.set("n", "e", api.fs.rename_basename, opts("Rename: Basename"))
435+
vim.keymap.set("n", "]e", api.node.navigate.diagnostics.next, opts("Next Diagnostic"))
436+
vim.keymap.set("n", "[e", api.node.navigate.diagnostics.prev, opts("Prev Diagnostic"))
437+
vim.keymap.set("n", "F", api.filter.live.clear, opts("Live Filter: Clear"))
438+
vim.keymap.set("n", "f", api.filter.live.start, opts("Live Filter: Start"))
439+
vim.keymap.set("n", "g?", api.tree.toggle_help, opts("Help"))
440+
vim.keymap.set({ "n", "x" }, "gy", api.fs.copy.absolute_path, opts("Copy Absolute Path"))
441+
vim.keymap.set({ "n", "x" }, "ge", api.fs.copy.basename, opts("Copy Basename"))
442+
vim.keymap.set("n", "H", api.filter.dotfiles.toggle, opts("Toggle Filter: Dotfiles"))
443+
vim.keymap.set("n", "I", api.filter.git.ignored.toggle, opts("Toggle Filter: Git Ignored"))
444+
vim.keymap.set("n", "J", api.node.navigate.sibling.last, opts("Last Sibling"))
445+
vim.keymap.set("n", "K", api.node.navigate.sibling.first, opts("First Sibling"))
446+
vim.keymap.set("n", "L", api.node.open.toggle_group_empty, opts("Toggle Group Empty"))
447+
vim.keymap.set("n", "M", api.filter.no_bookmark.toggle, opts("Toggle Filter: No Bookmark"))
448+
vim.keymap.set({ "n", "x" }, "m", api.marks.toggle, opts("Toggle Bookmark"))
449+
vim.keymap.set("n", "o", api.node.open.edit, opts("Open"))
450+
vim.keymap.set("n", "O", api.node.open.no_window_picker, opts("Open: No Window Picker"))
451+
vim.keymap.set("n", "p", api.fs.paste, opts("Paste"))
452+
vim.keymap.set("n", "gp", api.fs.paste_from_register_copying, opts("Paste Using Register"))
453+
vim.keymap.set("n", "gx", api.fs.paste_from_register_cutting, opts("Move Using Register"))
454+
vim.keymap.set("n", "P", api.node.navigate.parent, opts("Parent Directory"))
455+
vim.keymap.set("n", "q", api.tree.close, opts("Close"))
456+
vim.keymap.set("n", "r", api.fs.rename, opts("Rename"))
457+
vim.keymap.set("n", "R", api.tree.reload, opts("Refresh"))
458+
vim.keymap.set("n", "s", api.node.run.system, opts("Run System"))
459+
vim.keymap.set("n", "S", api.tree.search_node, opts("Search"))
460+
vim.keymap.set("n", "u", api.fs.rename_full, opts("Rename: Full Path"))
461+
vim.keymap.set("n", "U", api.filter.custom.toggle, opts("Toggle Filter: Custom"))
462+
vim.keymap.set("n", "W", api.tree.collapse_all, opts("Collapse All"))
463+
vim.keymap.set({ "n", "x" }, "x", api.fs.cut, opts("Cut"))
464+
vim.keymap.set("n", "y", api.fs.copy.filename, opts("Copy Name"))
465+
vim.keymap.set("n", "Y", api.fs.copy.relative_path, opts("Copy Relative Path"))
466+
vim.keymap.set("n", "<2-LeftMouse>", api.node.open.edit, opts("Open"))
467+
vim.keymap.set("n", "<2-RightMouse>", api.tree.change_root_to_node, opts("CD"))
468468
-- END_ON_ATTACH_DEFAULT
469469
<
470470
Alternatively, you may apply these default mappings from your
@@ -1698,8 +1698,6 @@ Config: actions *nvim-tree-config-actions*
16981698
Fields: ~
16991699
• {change_dir}? (`nvim_tree.config.actions.change_dir`)
17001700
|nvim_tree.config.actions.change_dir|
1701-
• {clipboard}? (`nvim_tree.config.actions.clipboard`)
1702-
|nvim_tree.config.actions.clipboard|
17031701
• {expand_all}? (`nvim_tree.config.actions.expand_all`)
17041702
|nvim_tree.config.actions.expand_all|
17051703
• {file_popup}? (`nvim_tree.config.actions.file_popup`)
@@ -1724,13 +1722,6 @@ Config: actions *nvim-tree-config-actions*
17241722
• {restrict_above_cwd}? (`boolean`, default: `false`) Restrict changing
17251723
to a directory above the global cwd.
17261724

1727-
*nvim_tree.config.actions.clipboard*
1728-
Customizes nvim-tree clipboard behaviour
1729-
1730-
Fields: ~
1731-
• {protocol}? (`string`, default: `nvim-tree`) Change the protocol
1732-
prefix to be used on multiple nvim instances operations
1733-
17341725
*nvim_tree.config.actions.expand_all*
17351726
Configure |nvim_tree.api.tree.expand_all()| and
17361727
|nvim_tree.api.node.expand()|
@@ -2161,9 +2152,6 @@ Following is the default configuration, see |nvim_tree.config| for details. >lua
21612152
},
21622153
actions = {
21632154
use_system_clipboard = true,
2164-
clipboard = {
2165-
protocol = "nvim-tree"
2166-
},
21672155
change_dir = {
21682156
enable = true,
21692157
global = false,
@@ -2428,13 +2416,6 @@ clear_clipboard() *nvim_tree.api.fs.clear_clipboard()*
24282416
copy.absolute_path({node}) *nvim_tree.api.fs.copy.absolute_path()*
24292417
Copy the absolute path to the system clipboard.
24302418

2431-
Parameters: ~
2432-
• {node} (`nvim_tree.api.Node?`)
2433-
2434-
*nvim_tree.api.fs.copy.absolute_path_with_protocol()*
2435-
copy.absolute_path_with_protocol({node})
2436-
Copy the absolute path to the system clipboard with nvim-tree protocol.
2437-
24382419
Parameters: ~
24392420
• {node} (`nvim_tree.api.Node?`)
24402421

@@ -2490,13 +2471,19 @@ paste({node}) *nvim_tree.api.fs.paste()*
24902471
Parameters: ~
24912472
• {node} (`nvim_tree.api.Node?`)
24922473

2493-
paste_with_protocol({node}) *nvim_tree.api.fs.paste_with_protocol()*
2494-
Paste nodes from the nvim-tree clipboard using protocol.
2474+
*nvim_tree.api.fs.paste_from_register_copying()*
2475+
paste_from_register_copying({node_or_nodes})
2476+
Paste nodes from the system register as files to nvim-tree while copying.
24952477

2496-
If {node} is a file it will pasted in the parent directory.
2478+
Parameters: ~
2479+
• {node_or_nodes} (`nvim_tree.api.Node|nvim_tree.api.Node[]?`)
2480+
2481+
*nvim_tree.api.fs.paste_from_register_cutting()*
2482+
paste_from_register_cutting({node_or_nodes})
2483+
Paste nodes from the system register as files to nvim-tree while cutting.
24972484

24982485
Parameters: ~
2499-
• {node} (`nvim_tree.api.Node?`)
2486+
• {node_or_nodes} (`nvim_tree.api.Node|nvim_tree.api.Node[]?`)
25002487

25012488
print_clipboard() *nvim_tree.api.fs.print_clipboard()*
25022489
Print the contents of the nvim-tree clipboard.

‎lua/nvim-tree/_meta/config/actions.lua‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ error("Cannot require a meta file")
99
---(default: `true`)
1010
---@field use_system_clipboard? boolean
1111
---
12-
---[nvim_tree.config.actions.clipboard]
13-
---@field clipboard? nvim_tree.config.actions.clipboard
14-
---
1512
---[nvim_tree.config.actions.change_dir]
1613
---@field change_dir? nvim_tree.config.actions.change_dir
1714
---
@@ -27,13 +24,6 @@ error("Cannot require a meta file")
2724
---[nvim_tree.config.actions.remove_file]
2825
---@field remove_file? nvim_tree.config.actions.remove_file
2926

30-
--- Customizes nvim-tree clipboard behaviour
31-
---@class nvim_tree.config.actions.clipboard
32-
---
33-
---Change the protocol prefix to be used on multiple nvim instances operations
34-
---(default: `nvim-tree`)
35-
---@field protocol? string
36-
3727
--- vim [current-directory] behaviour
3828
---@class nvim_tree.config.actions.change_dir
3929
---

‎lua/nvim-tree/actions/fs/clipboard.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ function Clipboard:resolve_conflicts(conflict, destination, action, action_fn)
319319
end)
320320
end
321321

322-
--- Transforms the copied absolute paths with protocols to node
322+
--- Transforms the copied absolute paths on register to node
323323
---@private
324324
function Clipboard:get_nodes_from_reg()
325325
local content = vim.fn.getreg(self.reg)

‎lua/nvim-tree/config.lua‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,9 +232,6 @@ M.d = { -- config-default-start
232232
},
233233
actions = {
234234
use_system_clipboard = true,
235-
clipboard = {
236-
protocol = "nvim-tree"
237-
},
238235
change_dir = {
239236
enable = true,
240237
global = false,

0 commit comments

Comments
 (0)