tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(mappings): POC for help and :help on_attach keymaps

Browse Source
This commit is contained in:
Alexander Courtis
2022-08-01 14:17:46 +10:00
parent 451901ca9c
commit 2df271038c
2 changed files with 238 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

236
lua/nvim-tree/keymap.lua
View File

@@ -2,236 +2,374 @@ local Api = require "nvim-tree.api"
local M = {}
local DEFAULT_KEYMAPS = {
M.DEFAULT_KEYMAPS = {
{
key = { "<CR>", "o", "<2-LeftMouse>" },
callback = Api.node.open.edit,
desc = "open a file or folder; root will cd to the above directory",
desc = {
long = "open a file or folder; root will cd to the above directory",
short = "Open",
},
},
{
key = "<C-e>",
callback = Api.node.open.replace_tree_buffer,
desc = "edit the file in place, effectively replacing the tree explorer",
desc = {
long = "edit the file in place, effectively replacing the tree explorer",
short = "Open: In Place",
},
},
{
key = "O",
callback = Api.node.open.no_window_picker,
desc = "same as (edit) with no window picker",
desc = {
long = "same as (edit) with no window picker",
short = "Open: No Window Picker",
},
},
{
key = { "<C-]>", "<2-RightMouse>" },
callback = Api.tree.change_root_to_node,
desc = "cd in the directory under the cursor",
desc = {
long = "cd in the directory under the cursor",
short = "cd",
},
},
{
key = "<C-v>",
callback = Api.node.open.vertical,
desc = "open the file in a vertical split",
desc = {
long = "open the file in a vertical split",
short = "Open: Vertical Split",
},
},
{
key = "<C-x>",
callback = Api.node.open.horizontal,
desc = "open the file in a horizontal split",
desc = {
long = "open the file in a horizontal split",
short = "Open: Horizontal Split",
},
},
{
key = "<C-t>",
callback = Api.node.open.tab,
desc = "open the file in a new tab",
desc = {
long = "open the file in a new tab",
short = "Open: New Tab",
},
},
{
key = "<",
callback = Api.node.navigate.sibling.prev,
desc = "navigate to the previous sibling of current file/directory",
desc = {
long = "navigate to the previous sibling of current file/directory",
short = "Previous Sibling",
},
},
{
key = ">",
callback = Api.node.navigate.sibling.next,
desc = "navigate to the next sibling of current file/directory",
desc = {
long = "navigate to the next sibling of current file/directory",
short = "Next Sibling",
},
},
{
key = "P",
callback = Api.node.navigate.parent,
desc = "move cursor to the parent directory",
desc = {
long = "move cursor to the parent directory",
short = "Parent Directory",
},
},
{
key = "<BS>",
callback = Api.node.navigate.parent_close,
desc = "close current opened directory or parent",
desc = {
long = "close current opened directory or parent",
short = "Close Folder",
},
},
{
key = "<Tab>",
callback = Api.node.open.preview,
desc = "open the file as a preview (keeps the cursor in the tree)",
desc = {
long = "open the file as a preview (keeps the cursor in the tree)",
short = "Open Preview",
},
},
{
key = "K",
callback = Api.node.navigate.sibling.first,
desc = "navigate to the first sibling of current file/directory",
desc = {
long = "navigate to the first sibling of current file/directory",
short = "First Sibling",
},
},
{
key = "J",
callback = Api.node.navigate.sibling.last,
desc = "navigate to the last sibling of current file/directory",
desc = {
long = "navigate to the last sibling of current file/directory",
short = "Last Sibling",
},
},
{
key = "I",
callback = Api.tree.toggle_gitignore_filter,
desc = "toggle visibility of files/folders hidden via |git.ignore| option",
desc = {
long = "toggle visibility of files/folders hidden via |git.ignore| option",
short = "Toggle Git Ignore",
},
},
{
key = "H",
callback = Api.tree.toggle_hidden_filter,
desc = "toggle visibility of dotfiles via |filters.dotfiles| option",
desc = {
long = "toggle visibility of dotfiles via |filters.dotfiles| option",
short = "Toggle Dotfiles",
},
},
{
key = "U",
callback = Api.tree.toggle_custom_filter,
desc = "toggle visibility of files/folders hidden via |filters.custom| option",
desc = {
long = "toggle visibility of files/folders hidden via |filters.custom| option",
short = "Toggle Hidden",
},
},
{
key = "R",
callback = Api.tree.reload,
desc = "refresh the tree",
desc = {
long = "refresh the tree",
short = "Refresh",
},
},
{
key = "a",
callback = Api.fs.create,
desc = "add a file; leaving a trailing `/` will add a directory",
desc = {
long = "add a file; leaving a trailing `/` will add a directory",
short = "Create",
},
},
{
key = "d",
callback = Api.fs.remove,
desc = "delete a file (will prompt for confirmation)",
desc = {
long = "delete a file (will prompt for confirmation)",
short = "Delete",
},
},
{
key = "D",
callback = Api.fs.trash,
desc = "trash a file via |trash| option",
desc = {
long = "trash a file via |trash| option",
short = "Trash",
},
},
{
key = "r",
callback = Api.fs.rename,
desc = "rename a file",
desc = {
long = "rename a file",
short = "Rename",
},
},
{
key = "<C-r>",
callback = Api.fs.rename_sub,
desc = "rename a file and omit the filename on input",
desc = {
long = "rename a file and omit the filename on input",
short = "Rename - Omit Filename",
},
},
{
key = "x",
callback = Api.fs.cut,
desc = "add/remove file/directory to cut clipboard",
desc = {
long = "add/remove file/directory to cut clipboard",
short = "Cut",
},
},
{
key = "c",
callback = Api.fs.copy.node,
desc = "add/remove file/directory to copy clipboard",
desc = {
long = "add/remove file/directory to copy clipboard",
short = "Copy",
},
},
{
key = "p",
callback = Api.fs.paste,
desc = "paste from clipboard; cut clipboard has precedence over copy; will prompt for confirmation",
desc = {
long = "paste from clipboard; cut clipboard has precedence over copy; will prompt for confirmation",
short = "Paste",
},
},
{
key = "y",
callback = Api.fs.copy.filename,
desc = "copy name to system clipboard",
desc = {
long = "copy name to system clipboard",
short = "Copy File Name",
},
},
{
key = "Y",
callback = Api.fs.copy.relative_path,
desc = "copy relative path to system clipboard",
desc = {
long = "copy relative path to system clipboard",
short = "Copy Relative Path",
},
},
{
key = "gy",
callback = Api.fs.copy.absolute_path,
desc = "copy absolute path to system clipboard",
desc = {
long = "copy absolute path to system clipboard",
short = "Copy Absolute Path",
},
},
{
key = "[e",
callback = Api.node.navigate.diagnostics.next,
desc = "go to next diagnostic item",
desc = {
long = "go to next diagnostic item",
short = "Next Diagnostic",
},
},
{
key = "[c",
callback = Api.node.navigate.git.next,
desc = "go to next git item",
desc = {
long = "go to next git item",
short = "Next Git",
},
},
{
key = "]e",
callback = Api.node.navigate.diagnostics.prev,
desc = "go to prev diagnostic item",
desc = {
long = "go to prev diagnostic item",
short = "Prev Diagnostic",
},
},
{
key = "]c",
callback = Api.node.navigate.git.prev,
desc = "go to prev git item",
desc = {
long = "go to prev git item",
short = "Prev Git",
},
},
{
key = "-",
callback = Api.tree.change_root_to_parent,
desc = "navigate up to the parent directory of the current file/directory",
desc = {
long = "navigate up to the parent directory of the current file/directory",
short = "Up",
},
},
{
key = "s",
callback = Api.node.run.system,
desc = "open a file with default system application or a folder with default file manager, using |system_open| option",
desc = {
long = "open a file with default system application or a folder with default file manager, using |system_open| option",
short = "Run System",
},
},
{
key = "f",
callback = Api.live_filter.start,
desc = "live filter nodes dynamically based on regex matching.",
desc = {
long = "live filter nodes dynamically based on regex matching.",
short = "Filter",
},
},
{
key = "F",
callback = Api.live_filter.clear,
desc = "clear live filter",
desc = {
long = "clear live filter",
short = "Clean Filter",
},
},
{
key = "q",
callback = Api.tree.close,
desc = "close tree window",
desc = {
long = "close tree window",
short = "Close",
},
},
{
key = "W",
callback = Api.tree.collapse_all,
desc = "collapse the whole tree",
desc = {
long = "collapse the whole tree",
short = "Collapse",
},
},
{
key = "E",
callback = Api.tree.expand_all,
desc = "expand the whole tree, stopping after expanding |callbacks.expand_all.max_folder_discovery| folders; this might hang neovim for a while if running on a big folder",
desc = {
long = "expand the whole tree, stopping after expanding |callbacks.expand_all.max_folder_discovery| folders; this might hang neovim for a while if running on a big folder",
short = "Expand All",
},
},
{
key = "S",
callback = Api.tree.search_node,
desc = "prompt the user to enter a path and then expands the tree to match the path",
desc = {
long = "prompt the user to enter a path and then expands the tree to match the path",
short = "Search",
},
},
{
key = ".",
callback = Api.node.run.cmd,
desc = "enter vim command mode with the file the cursor is on",
desc = {
long = "enter vim command mode with the file the cursor is on",
short = "Run Command",
},
},
{
key = "<C-k>",
callback = Api.node.show_info_popup,
desc = "toggle a popup with file infos about the file under the cursor",
desc = {
long = "toggle a popup with file infos about the file under the cursor",
short = "Info",
},
},
{
key = "g?",
callback = Api.tree.toggle_help,
desc = "toggle help",
desc = {
long = "toggle help",
short = "Help",
},
},
{
key = "m",
callback = Api.marks.toggle,
desc = "Toggle node in bookmarks",
desc = {
long = "Toggle node in bookmarks",
short = "Toggle Bookmark",
},
},
{
key = "bmv",
callback = Api.marks.bulk.move,
desc = "Move all bookmarked nodes into specified location",
desc = {
long = "Move all bookmarked nodes into specified location",
short = "Move Bookmarked",
},
},
}
@@ -247,7 +385,7 @@ end
local function filter_default_mappings(keys_to_disable)
local new_map = {}
for _, m in pairs(DEFAULT_KEYMAPS) do
for _, m in pairs(M.DEFAULT_KEYMAPS) do
local keys = type(m.key) == "table" and m.key or { m.key }
local reminding_keys = {}
for _, key in pairs(keys) do
@@ -280,7 +418,7 @@ local function get_keymaps(keys_to_disable)
return filter_default_mappings(keys_to_disable)
end
return DEFAULT_KEYMAPS
return M.DEFAULT_KEYMAPS
end
function M.setup(opts)

67
lua/nvim-tree/renderer/help.lua
View File

@@ -1,27 +1,62 @@
local log = require "nvim-tree.log"
local M = {}
local function shorten_lhs(lhs)
lhs = lhs:gsub("LeftMouse", "LM")
lhs = lhs:gsub("RightMouse", "RM")
lhs = lhs:gsub("MiddleMouse", "MM")
lhs = lhs:gsub("ScrollWheelDown", "SWD")
lhs = lhs:gsub("ScrollWheelUp", "SWU")
lhs = lhs:gsub("ScrollWheelLeft", "SWL")
lhs = lhs:gsub("ScrollWheelRight", "SWR")
return lhs
end
function M.compute_lines()
local help_lines = { "HELP" }
local help_hl = { { "NvimTreeRootFolder", 0, 0, #help_lines[1] } }
local mappings = vim.tbl_filter(function(v)
return (v.cb ~= nil and v.cb ~= "") or (v.action ~= nil and v.action ~= "")
end, require("nvim-tree.actions").mappings)
local buf_keymaps = vim.api.nvim_buf_get_keymap(vim.api.nvim_get_current_buf(), "n")
log.line("dev", "%s", vim.inspect(buf_keymaps))
local processed = {}
for _, b in pairs(mappings) do
local cb = b.cb
local key = b.key
local name
if cb and cb:sub(1, 35) == require("nvim-tree.config").nvim_tree_callback("test"):sub(1, 35) then
name = cb:match "'[^']+'[^']*$"
name = name:match "'[^']+'"
elseif b.action then
name = b.action
else
name = (b.name ~= nil) and b.name or cb
name = '"' .. name .. '"'
for _, bkm in ipairs(buf_keymaps) do
local default_keymap = nil
for _, dkm in ipairs(require("nvim-tree.keymap").DEFAULT_KEYMAPS) do
if bkm.callback == dkm.callback then
default_keymap = dkm
end
end
local lhs = shorten_lhs(bkm.lhs)
if default_keymap then
table.insert(processed, { lhs, default_keymap.desc.short })
else
table.insert(processed, { lhs, "<user>" })
end
table.insert(processed, { key, name, true })
end
-- local mappings = vim.tbl_filter(function(v)
-- return (v.cb ~= nil and v.cb ~= "") or (v.action ~= nil and v.action ~= "")
-- end, require("nvim-tree.actions").mappings)
-- local processed = {}
-- for _, b in pairs(mappings) do
-- local cb = b.cb
-- local key = b.key
-- local name
-- if cb and cb:sub(1, 35) == require("nvim-tree.config").nvim_tree_callback("test"):sub(1, 35) then
-- name = cb:match "'[^']+'[^']*$"
-- name = name:match "'[^']+'"
-- elseif b.action then
-- name = b.action
-- else
-- name = (b.name ~= nil) and b.name or cb
-- name = '"' .. name .. '"'
-- end
-- table.insert(processed, { key, name, true })
-- end
table.sort(processed, function(a, b)
return (a[3] == b[3] and (a[2] < b[2] or (a[2] == b[2] and #a[1] < #b[1]))) or (a[3] and not b[3])
end)