From 5920a683a6c509dab6a665f7c6981bc9c0912d18 Mon Sep 17 00:00:00 2001 From: Pratik Tripathy Date: Sun, 10 Mar 2024 22:07:59 +0530 Subject: [PATCH] NVIM - Key map descriptions changed --- .../nvim/lua/plugins/code-completion.lua | 1 + .../nvim/lua/plugins/code-formatting.lua | 2 +- .../.config/nvim/lua/plugins/code-generic.lua | 2 +- common/.config/nvim/lua/plugins/code-lsp.lua | 8 +- .../nvim/lua/plugins/navigate-files.lua | 76 ++++++++----------- .../nvim/lua/plugins/utility-plugs.lua | 20 ++--- 6 files changed, 50 insertions(+), 59 deletions(-) diff --git a/common/.config/nvim/lua/plugins/code-completion.lua b/common/.config/nvim/lua/plugins/code-completion.lua index 77895b4..d6598c5 100644 --- a/common/.config/nvim/lua/plugins/code-completion.lua +++ b/common/.config/nvim/lua/plugins/code-completion.lua @@ -74,6 +74,7 @@ return { { "L3MON4D3/LuaSnip", keys = { + -- TODO: Verify if this fixed the tab-going-crazy-sometimes issue -- { -- "", -- function() diff --git a/common/.config/nvim/lua/plugins/code-formatting.lua b/common/.config/nvim/lua/plugins/code-formatting.lua index c74fdcc..0a76f51 100644 --- a/common/.config/nvim/lua/plugins/code-formatting.lua +++ b/common/.config/nvim/lua/plugins/code-formatting.lua @@ -44,7 +44,7 @@ return { async = false, timeout_ms = 1000, }) - end, { desc = "[C]ode [F]ormat (visual selection)" }) + end, { desc = "Code Format (visual selection)" }) end, }, } diff --git a/common/.config/nvim/lua/plugins/code-generic.lua b/common/.config/nvim/lua/plugins/code-generic.lua index ab1e05e..a89e8f5 100644 --- a/common/.config/nvim/lua/plugins/code-generic.lua +++ b/common/.config/nvim/lua/plugins/code-generic.lua @@ -219,7 +219,7 @@ return { function() return require("nvim-navbuddy").open() end, - desc = "N[v]igate through document symbols", + desc = "Navigate through document symbols", }, }, }, diff --git a/common/.config/nvim/lua/plugins/code-lsp.lua b/common/.config/nvim/lua/plugins/code-lsp.lua index a79af96..35143a6 100644 --- a/common/.config/nvim/lua/plugins/code-lsp.lua +++ b/common/.config/nvim/lua/plugins/code-lsp.lua @@ -10,17 +10,17 @@ local on_attach = function(_, bufnr) vim.keymap.set("n", keys, func, { buffer = bufnr, desc = desc }) end - nmap("cr", vim.lsp.buf.rename, "[R]ename Symbol") - nmap("ca", vim.lsp.buf.code_action, "[C]ode [A]ction") + nmap("cr", vim.lsp.buf.rename, "Rename Symbol") + nmap("ca", vim.lsp.buf.code_action, "Code Action") -- See `:help K` for why this keymap nmap("K", vim.lsp.buf.hover, "Hover Documentation") -- nmap("", vim.lsp.buf.signature_help, "Signature Documentation") -- Lesser used LSP functionality - nmap("cS", require("telescope.builtin").lsp_dynamic_workspace_symbols, "Search Workspace [S]symbols") + nmap("cS", require("telescope.builtin").lsp_dynamic_workspace_symbols, "Search Workspace Symbols") nmap("clf", function() print(vim.inspect(vim.lsp.buf.list_workspace_folders())) - end, "Workspace [L]ist [F]olders") + end, "Workspace List Folders") -- Create a command `:Format` local to the LSP buffer vim.api.nvim_buf_create_user_command(bufnr, "Format", function(_) diff --git a/common/.config/nvim/lua/plugins/navigate-files.lua b/common/.config/nvim/lua/plugins/navigate-files.lua index 23c5cf0..f0596ba 100644 --- a/common/.config/nvim/lua/plugins/navigate-files.lua +++ b/common/.config/nvim/lua/plugins/navigate-files.lua @@ -4,14 +4,14 @@ return { "nvim-neo-tree/neo-tree.nvim", branch = "v3.x", keys = { - { "e", ":Neotree filesystem toggle", desc = "Open NeoTree [E]plorer at Git root", remap = true }, + { "e", ":Neotree filesystem toggle", desc = "Open NeoTree Explorer at Git root", remap = true }, { "be", function() require("neo-tree.command").execute({ source = "buffers", toggle = true }) end, - desc = "NeoTree: Open [B]buffer [E]xplorer", + desc = "NeoTree: Open Buffer Explorer", }, }, deactivate = function() @@ -145,56 +145,46 @@ return { -- Load some required Telescope extensions pcall(require("telescope").load_extension, "fzf") - -- Special Things: [T]elescope - vim.keymap.set("n", "nc", require("telescope.builtin").colorscheme, { desc = "List [N]eovim [C]olorschemes (with preview)" }) + -- Special Things: Telescope + vim.keymap.set("n", "nc", require("telescope.builtin").colorscheme, { desc = "List Neovim Colorschemes (with preview)" }) - -- Grep things -> [S]earch + -- Grep things -> Search vim.keymap.set("n", "sb", function() require("telescope.builtin").live_grep({ grep_open_files = true, prompt_title = "Live Grep in Open Files", }) - end, { desc = "[S]earch Open [B]buffers" }) - vim.keymap.set("n", "sg", require("telescope.builtin").live_grep, { desc = "[S]earch/Live[G]rep the Project" }) - vim.keymap.set("n", "sw", require("telescope.builtin").grep_string, { desc = "[S]earch current [W]ord in Project" }) + end, { desc = "Search Open Buffers" }) + vim.keymap.set("n", "sg", require("telescope.builtin").live_grep, { desc = "Search/LiveGrep the Project" }) + vim.keymap.set("n", "sw", require("telescope.builtin").grep_string, { desc = "Search current Word in Project" }) - -- [L]ist - vim.keymap.set("n", "lb", require("telescope.builtin").buffers, { desc = "[L]ist [B]buffers" }) - vim.keymap.set("n", "lc", require("telescope.builtin").command_history, { desc = "[L]ist NeoVIM [C]ommand History" }) - vim.keymap.set("n", "", require("telescope.builtin").find_files, { desc = "[L]ist & Search [F]iles" }) - vim.keymap.set("n", "lf", require("telescope.builtin").find_files, { desc = "[L]ist & Search [F]iles" }) - vim.keymap.set("n", "lh", require("telescope.builtin").help_tags, { desc = "[L]ist & Search NeoVIM [H]elp" }) - vim.keymap.set("n", "lk", require("telescope.builtin").keymaps, { desc = "[L]ist & Search NeoVIM [K]eymaps" }) - vim.keymap.set("n", "lm", require("telescope.builtin").man_pages, { desc = "[L]ist & Search System Ma[n] Pages" }) - vim.keymap.set("n", "lq", require("telescope.builtin").quickfixhistory, { desc = "[L]ist [Q]uickfix History" }) - vim.keymap.set("n", "ls", require("telescope.builtin").search_history, { desc = "[L]ist [S]earch History" }) - vim.keymap.set("n", "lv", require("telescope.builtin").vim_options, { desc = "[L]ist [V]im Options" }) + -- List + vim.keymap.set("n", "lb", require("telescope.builtin").buffers, { desc = "List Bbuffers" }) + vim.keymap.set("n", "lc", require("telescope.builtin").command_history, { desc = "List NeoVIM Command History" }) + vim.keymap.set("n", "", require("telescope.builtin").find_files, { desc = "List & Search Files" }) + vim.keymap.set("n", "lf", require("telescope.builtin").find_files, { desc = "List & Search Files" }) + vim.keymap.set("n", "lh", require("telescope.builtin").help_tags, { desc = "List & Search NeoVIM Help" }) + vim.keymap.set("n", "lk", require("telescope.builtin").keymaps, { desc = "List & Search NeoVIM Keymaps" }) + vim.keymap.set("n", "lm", require("telescope.builtin").man_pages, { desc = "List & Search System Man Pages" }) + vim.keymap.set("n", "lq", require("telescope.builtin").quickfixhistory, { desc = "List Quickfix History" }) + vim.keymap.set("n", "ls", require("telescope.builtin").search_history, { desc = "List Search History" }) + vim.keymap.set("n", "lv", require("telescope.builtin").vim_options, { desc = "List Vim Options" }) - -- Git things -> [G]it - vim.keymap.set("n", "glb", require("telescope.builtin").git_branches, { desc = "List [G]it [B]ranches" }) - vim.keymap.set("n", "glc", require("telescope.builtin").git_commits, { desc = "List [G]it [C]omits" }) + -- Git things -> Git + vim.keymap.set("n", "glb", require("telescope.builtin").git_branches, { desc = "List Git Branches" }) + vim.keymap.set("n", "glc", require("telescope.builtin").git_commits, { desc = "List Git Commits" }) - -- LSP Things -> [C]oding - vim.keymap.set("n", "cd", require("telescope.builtin").diagnostics, { desc = "[C]ode: List [D]iagnostics" }) - vim.keymap.set( - "n", - "ci", - require("telescope.builtin").lsp_implementations, - { desc = "[C]ode: Goto [I]mplementation of the word under cursor" } - ) - vim.keymap.set("n", "cR", require("telescope.builtin").lsp_references, { desc = "[C]ode: List [R]eferences for word under cursor" }) - vim.keymap.set( - "n", - "cgt", - require("telescope.builtin").lsp_type_definitions, - { desc = "[C]ode: Goto definition of the [T]ype under cursor" } - ) - vim.keymap.set("n", "gd", require("telescope.builtin").lsp_definitions, { desc = "[G]oto [D]efinition" }) - vim.keymap.set("n", "cgd", require("telescope.builtin").lsp_type_definitions, { desc = "Type [D]efinition" }) - vim.keymap.set("n", "cR", require("telescope.builtin").lsp_references, { desc = "[G]oto [R]eferences" }) - vim.keymap.set("n", "cI", require("telescope.builtin").lsp_implementations, { desc = "[G]oto [I]mplementation" }) - vim.keymap.set("n", "cs", require("telescope.builtin").lsp_document_symbols, { desc = "[D]ocument [S]symbols" }) - -- vim.keymap.set("n", "cgD", vim.lsp.buf.declaration, { desc = "[G]oto [D]eclaration" }) + -- LSP Things -> Coding + vim.keymap.set("n", "cd", require("telescope.builtin").diagnostics, { desc = "Code: List Diagnostics" }) + vim.keymap.set("n", "ci", require("telescope.builtin").lsp_implementations, { desc = "Code: Goto Implementation of the word under cursor" }) + vim.keymap.set("n", "cR", require("telescope.builtin").lsp_references, { desc = "Code: List References for word under cursor" }) + vim.keymap.set("n", "cgt", require("telescope.builtin").lsp_type_definitions, { desc = "Code: Goto definition of the Type under cursor" }) + vim.keymap.set("n", "gd", require("telescope.builtin").lsp_definitions, { desc = "Goto Definition" }) + vim.keymap.set("n", "cgd", require("telescope.builtin").lsp_type_definitions, { desc = "Type Definition" }) + vim.keymap.set("n", "cR", require("telescope.builtin").lsp_references, { desc = "Goto References" }) + vim.keymap.set("n", "cI", require("telescope.builtin").lsp_implementations, { desc = "Goto Implementation" }) + vim.keymap.set("n", "cs", require("telescope.builtin").lsp_document_symbols, { desc = "Document Symbols" }) + -- vim.keymap.set("n", "cgD", vim.lsp.buf.declaration, { desc = "Goto Declaration" }) end, }, } diff --git a/common/.config/nvim/lua/plugins/utility-plugs.lua b/common/.config/nvim/lua/plugins/utility-plugs.lua index 73448fe..54b6be8 100644 --- a/common/.config/nvim/lua/plugins/utility-plugs.lua +++ b/common/.config/nvim/lua/plugins/utility-plugs.lua @@ -46,22 +46,22 @@ return { config = function() -- document existing key chains require("which-key").register({ - ["c"] = { name = "[C]ode", _ = "which_key_ignore" }, - ["b"] = { name = "[B]buffer Operations", _ = "which_key_ignore" }, - ["d"] = { name = "[D]iagnostics", _ = "which_key_ignore" }, - ["f"] = { name = "[F]ile Operations", _ = "which_key_ignore" }, - ["g"] = { name = "[G]it Operations", _ = "which_key_ignore" }, - ["l"] = { name = "[L]ist Things", _ = "which_key_ignore" }, - ["n"] = { name = "[N]VIM Operations", _ = "which_key_ignore" }, - ["s"] = { name = "[S]earch/Grep Things", _ = "which_key_ignore" }, - ["t"] = { name = "Unit [T]est Operations", _ = "which_key_ignore" }, + ["c"] = { name = "Code", _ = "which_key_ignore" }, + ["b"] = { name = "Buffer Operations", _ = "which_key_ignore" }, + ["d"] = { name = "Diagnostics", _ = "which_key_ignore" }, + ["f"] = { name = "File Operations", _ = "which_key_ignore" }, + ["g"] = { name = "Git Operations", _ = "which_key_ignore" }, + ["l"] = { name = "List Things", _ = "which_key_ignore" }, + ["n"] = { name = "NVIM Operations", _ = "which_key_ignore" }, + ["s"] = { name = "Search/Grep Things", _ = "which_key_ignore" }, + ["t"] = { name = "Unit Test Operations", _ = "which_key_ignore" }, ["x"] = { name = "Delete/Remove Something", _ = "which_key_ignore" }, }) -- register which-key VISUAL mode -- required for visual hs (hunk stage) to work require("which-key").register({ [""] = { name = "VISUAL " }, - ["h"] = { "Git [H]unk" }, + ["h"] = { "Git Hunk" }, }, { mode = "v" }) end, },