From 63d12086787a4e7c5aec639120a770b66dc6b224 Mon Sep 17 00:00:00 2001 From: Daniel McKnight Date: Wed, 21 May 2025 16:42:29 -0700 Subject: [PATCH] Configure which-key and add descriptions to key binds --- nvim/init.lua | 10 +++++----- nvim/lua/plugins/git.lua | 24 ++++++++++++------------ nvim/lua/plugins/none-ls.lua | 2 +- nvim/lua/plugins/nvim-lspconfig.lua | 6 +++--- nvim/lua/plugins/which-key.lua | 4 ++++ 5 files changed, 25 insertions(+), 21 deletions(-) create mode 100644 nvim/lua/plugins/which-key.lua diff --git a/nvim/init.lua b/nvim/init.lua index 43d9da7..376047a 100644 --- a/nvim/init.lua +++ b/nvim/init.lua @@ -21,15 +21,15 @@ require("config.lazy") -- Configure Telescope Keymaps local builtin = require("telescope.builtin") -vim.keymap.set('n', '', builtin.find_files, {}) -vim.keymap.set('n', 'gg', builtin.live_grep, {}) +vim.keymap.set("n", "", builtin.find_files, {}) +vim.keymap.set("n", "gg", builtin.live_grep, { desc = "Grep Files" }) -- Init Treesitter Syntax Highlighting --require("config.treesitter") -- Configure NeoTree (FS View) -vim.keymap.set('n', 'f', ':Neotree filesystem reveal left') +vim.keymap.set("n", "f", ":Neotree filesystem reveal left") -- Configure Git -vim.keymap.set('n', 'gd', ':Gitsigns preview_hunk', {}) -vim.keymap.set('n', 'gb', ':Gitsigns toggle_current_line_blame', {}) +vim.keymap.set("n", "gd", ":Gitsigns preview_hunk", { desc = "Git Diff" }) +vim.keymap.set("n", "gb", ":Gitsigns toggle_current_line_blame", { desc = "Git Blame" }) diff --git a/nvim/lua/plugins/git.lua b/nvim/lua/plugins/git.lua index e5c3471..bec3e1e 100644 --- a/nvim/lua/plugins/git.lua +++ b/nvim/lua/plugins/git.lua @@ -1,14 +1,14 @@ return { - { - "tpope/vim-fugitive", - }, - { - "lewis6991/gitsigns.nvim", - tag = "v1.0.2", - config = function() - require("gitsigns").setup({ - current_line_blame = true - }) - end, - }, + { + "tpope/vim-fugitive", + }, + { + "lewis6991/gitsigns.nvim", + tag = "v1.0.2", + config = function() + require("gitsigns").setup({ + current_line_blame = true, + }) + end, + }, } diff --git a/nvim/lua/plugins/none-ls.lua b/nvim/lua/plugins/none-ls.lua index 2c3f664..9cdc15f 100644 --- a/nvim/lua/plugins/none-ls.lua +++ b/nvim/lua/plugins/none-ls.lua @@ -7,6 +7,6 @@ return { null_ls.builtins.formatting.stylua, }, }) - vim.keymap.set("n", "af", vim.lsp.buf.format, {}) + vim.keymap.set("n", "af", vim.lsp.buf.format, {desc="Auto-Format File"}) end, } diff --git a/nvim/lua/plugins/nvim-lspconfig.lua b/nvim/lua/plugins/nvim-lspconfig.lua index de26634..0afe16e 100644 --- a/nvim/lua/plugins/nvim-lspconfig.lua +++ b/nvim/lua/plugins/nvim-lspconfig.lua @@ -11,8 +11,8 @@ return { lspconfig.nginx_language_server.setup({}) lspconfig.ruff.setup({}) lspconfig.yamlls.setup({}) - vim.keymap.set('n', 'd', vim.lsp.buf.hover, {}) - vim.keymap.set('n', 'gt', vim.lsp.buf.definition, {}) - vim.keymap.set('n', 'ca', vim.lsp.buf.code_action, {}) + vim.keymap.set('n', 'd', vim.lsp.buf.hover, {desc="Show Docstring"}) + vim.keymap.set('n', 'gt', vim.lsp.buf.definition, {desc="Go To Definition"}) + vim.keymap.set('n', 'ca', vim.lsp.buf.code_action, {desc="Show Code Actions"}) end } diff --git a/nvim/lua/plugins/which-key.lua b/nvim/lua/plugins/which-key.lua new file mode 100644 index 0000000..e75cabb --- /dev/null +++ b/nvim/lua/plugins/which-key.lua @@ -0,0 +1,4 @@ +return { + "folke/which-key.nvim", + event = "VeryLazy" +}