Skip to content

Commit 887e6c1

Browse files
committed
refactor(docs): update api docs and rename paste_while_cutting to move
1 parent 6f1b818 commit 887e6c1

3 files changed

Lines changed: 8 additions & 10 deletions

File tree

doc/nvim-tree-lua.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,7 @@ Show the mappings: `g?`
154154
`o` n Open |nvim_tree.api.node.open.edit()|
155155
`O` n Open: No Window Picker |nvim_tree.api.node.open.no_window_picker()|
156156
`p` n Paste |nvim_tree.api.fs.paste()|
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()|
157+
`gp` n Move |nvim_tree.api.fs.move()|
159158
`P` n Parent Directory |nvim_tree.api.node.navigate.parent()|
160159
`q` n Close |nvim_tree.api.tree.close()|
161160
`r` n Rename |nvim_tree.api.fs.rename()|
@@ -166,8 +165,8 @@ Show the mappings: `g?`
166165
`U` n Toggle Filter: Custom |nvim_tree.api.filter.custom.toggle()|
167166
`W` n Collapse All |nvim_tree.api.tree.collapse_all()|
168167
`x` nx Cut |nvim_tree.api.fs.cut()|
169-
`y` n Copy Name |nvim_tree.api.fs.copy.filename()|
170-
`Y` n Copy Relative Path |nvim_tree.api.fs.copy.relative_path()|
168+
`y` nx Copy Name |nvim_tree.api.fs.copy.filename()|
169+
`Y` nx Copy Relative Path |nvim_tree.api.fs.copy.relative_path()|
171170
`<2-LeftMouse>` n Open |nvim_tree.api.node.open.edit()|
172171
`<2-RightMouse>` n CD |nvim_tree.api.tree.change_root_to_node()|
173172

@@ -449,8 +448,7 @@ You are encouraged to copy these to your {on_attach} function. >lua
449448
vim.keymap.set("n", "o", api.node.open.edit, opts("Open"))
450449
vim.keymap.set("n", "O", api.node.open.no_window_picker, opts("Open: No Window Picker"))
451450
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"))
451+
vim.keymap.set("n", "gp", api.fs.move, opts("Move"))
454452
vim.keymap.set("n", "P", api.node.navigate.parent, opts("Parent Directory"))
455453
vim.keymap.set("n", "q", api.tree.close, opts("Close"))
456454
vim.keymap.set("n", "r", api.fs.rename, opts("Rename"))
@@ -461,8 +459,8 @@ You are encouraged to copy these to your {on_attach} function. >lua
461459
vim.keymap.set("n", "U", api.filter.custom.toggle, opts("Toggle Filter: Custom"))
462460
vim.keymap.set("n", "W", api.tree.collapse_all, opts("Collapse All"))
463461
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"))
462+
vim.keymap.set({ "n", "x" }, "y", api.fs.copy.filename, opts("Copy Name"))
463+
vim.keymap.set({ "n", "x" }, "Y", api.fs.copy.relative_path, opts("Copy Relative Path"))
466464
vim.keymap.set("n", "<2-LeftMouse>", api.node.open.edit, opts("Open"))
467465
vim.keymap.set("n", "<2-RightMouse>", api.tree.change_root_to_node, opts("CD"))
468466
-- END_ON_ATTACH_DEFAULT

lua/nvim-tree/api/impl.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ function M.hydrate_post_setup(api)
163163
api.fs.create = _n(function(n) require("nvim-tree.actions.fs.create-file").fn(n) end)
164164
api.fs.cut = ev(function(e, n) e.clipboard:cut(n) end)
165165
api.fs.paste = en(function(e, n) e.clipboard:paste(n) end)
166-
api.fs.paste_while_cutting = en(function(e, n) e.clipboard:paste(n, { cut = true }) end)
166+
api.fs.move = en(function(e, n) e.clipboard:paste(n, { cut = true }) end)
167167
api.fs.print_clipboard = e_(function(e) e.clipboard:print_clipboard() end)
168168
api.fs.remove = _v(function(n) require("nvim-tree.actions.fs.remove-file").fn(n) end)
169169
api.fs.rename = _n(function(n) require("nvim-tree.actions.fs.rename-file").rename_node(n) end)

lua/nvim-tree/keymap.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ function M.on_attach_default(bufnr)
102102
vim.keymap.set("n", "o", api.node.open.edit, opts("Open"))
103103
vim.keymap.set("n", "O", api.node.open.no_window_picker, opts("Open: No Window Picker"))
104104
vim.keymap.set("n", "p", api.fs.paste, opts("Paste"))
105-
vim.keymap.set("n", "gp", api.fs.paste_while_cutting, opts("Move"))
105+
vim.keymap.set("n", "gp", api.fs.move, opts("Move"))
106106
vim.keymap.set("n", "P", api.node.navigate.parent, opts("Parent Directory"))
107107
vim.keymap.set("n", "q", api.tree.close, opts("Close"))
108108
vim.keymap.set("n", "r", api.fs.rename, opts("Rename"))

0 commit comments

Comments
 (0)