which-key.lua 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. local M = {}
  2. M.config = function()
  3. lvim.builtin.which_key = {
  4. ---@usage disable which-key completely [not recommeded]
  5. active = true,
  6. on_config_done = nil,
  7. setup = {
  8. plugins = {
  9. marks = true, -- shows a list of your marks on ' and `
  10. registers = true, -- shows your registers on " in NORMAL or <C-r> in INSERT mode
  11. -- the presets plugin, adds help for a bunch of default keybindings in Neovim
  12. -- No actual key bindings are created
  13. presets = {
  14. operators = false, -- adds help for operators like d, y, ...
  15. motions = false, -- adds help for motions
  16. text_objects = false, -- help for text objects triggered after entering an operator
  17. windows = true, -- default bindings on <c-w>
  18. nav = true, -- misc bindings to work with windows
  19. z = true, -- bindings for folds, spelling and others prefixed with z
  20. g = true, -- bindings for prefixed with g
  21. },
  22. spelling = { enabled = true, suggestions = 20 }, -- use which-key for spelling hints
  23. },
  24. icons = {
  25. breadcrumb = "»", -- symbol used in the command line area that shows your active key combo
  26. separator = "➜", -- symbol used between a key and it's label
  27. group = "+", -- symbol prepended to a group
  28. },
  29. window = {
  30. border = "single", -- none, single, double, shadow
  31. position = "bottom", -- bottom, top
  32. margin = { 1, 0, 1, 0 }, -- extra window margin [top, right, bottom, left]
  33. padding = { 2, 2, 2, 2 }, -- extra window padding [top, right, bottom, left]
  34. },
  35. layout = {
  36. height = { min = 4, max = 25 }, -- min and max height of the columns
  37. width = { min = 20, max = 50 }, -- min and max width of the columns
  38. spacing = 3, -- spacing between columns
  39. },
  40. hidden = { "<silent>", "<cmd>", "<Cmd>", "<CR>", "call", "lua", "^:", "^ " }, -- hide mapping boilerplate
  41. show_help = true, -- show help message on the command line when the popup is visible
  42. },
  43. opts = {
  44. mode = "n", -- NORMAL mode
  45. prefix = "<leader>",
  46. buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
  47. silent = true, -- use `silent` when creating keymaps
  48. noremap = true, -- use `noremap` when creating keymaps
  49. nowait = true, -- use `nowait` when creating keymaps
  50. },
  51. vopts = {
  52. mode = "v", -- VISUAL mode
  53. prefix = "<leader>",
  54. buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
  55. silent = true, -- use `silent` when creating keymaps
  56. noremap = true, -- use `noremap` when creating keymaps
  57. nowait = true, -- use `nowait` when creating keymaps
  58. },
  59. -- NOTE: Prefer using : over <cmd> as the latter avoids going back in normal-mode.
  60. -- see https://neovim.io/doc/user/map.html#:map-cmd
  61. vmappings = {
  62. ["/"] = { ":CommentToggle<CR>", "Comment" },
  63. },
  64. mappings = {
  65. ["w"] = { "<cmd>w!<CR>", "Save" },
  66. ["q"] = { "<cmd>q!<CR>", "Quit" },
  67. ["/"] = { "<cmd>CommentToggle<CR>", "Comment" },
  68. ["c"] = { "<cmd>BufferClose!<CR>", "Close Buffer" },
  69. ["f"] = { "<cmd>Telescope find_files<CR>", "Find File" },
  70. ["h"] = { "<cmd>nohlsearch<CR>", "No Highlight" },
  71. b = {
  72. name = "Buffers",
  73. j = { "<cmd>BufferPick<cr>", "jump to buffer" },
  74. f = { "<cmd>Telescope buffers<cr>", "Find buffer" },
  75. w = { "<cmd>BufferWipeout<cr>", "wipeout buffer" },
  76. e = {
  77. "<cmd>BufferCloseAllButCurrent<cr>",
  78. "close all but current buffer",
  79. },
  80. h = { "<cmd>BufferCloseBuffersLeft<cr>", "close all buffers to the left" },
  81. l = {
  82. "<cmd>BufferCloseBuffersRight<cr>",
  83. "close all BufferLines to the right",
  84. },
  85. D = {
  86. "<cmd>BufferOrderByDirectory<cr>",
  87. "sort BufferLines automatically by directory",
  88. },
  89. L = {
  90. "<cmd>BufferOrderByLanguage<cr>",
  91. "sort BufferLines automatically by language",
  92. },
  93. },
  94. p = {
  95. name = "Packer",
  96. c = { "<cmd>PackerCompile<cr>", "Compile" },
  97. i = { "<cmd>PackerInstall<cr>", "Install" },
  98. r = { "<cmd>lua require('utils').reload_lv_config()<cr>", "Reload" },
  99. s = { "<cmd>PackerSync<cr>", "Sync" },
  100. S = { "<cmd>PackerStatus<cr>", "Status" },
  101. u = { "<cmd>PackerUpdate<cr>", "Update" },
  102. },
  103. -- " Available Debug Adapters:
  104. -- " https://microsoft.github.io/debug-adapter-protocol/implementors/adapters/
  105. -- " Adapter configuration and installation instructions:
  106. -- " https://github.com/mfussenegger/nvim-dap/wiki/Debug-Adapter-installation
  107. -- " Debug Adapter protocol:
  108. -- " https://microsoft.github.io/debug-adapter-protocol/
  109. -- " Debugging
  110. g = {
  111. name = "Git",
  112. j = { "<cmd>lua require 'gitsigns'.next_hunk()<cr>", "Next Hunk" },
  113. k = { "<cmd>lua require 'gitsigns'.prev_hunk()<cr>", "Prev Hunk" },
  114. l = { "<cmd>lua require 'gitsigns'.blame_line()<cr>", "Blame" },
  115. p = { "<cmd>lua require 'gitsigns'.preview_hunk()<cr>", "Preview Hunk" },
  116. r = { "<cmd>lua require 'gitsigns'.reset_hunk()<cr>", "Reset Hunk" },
  117. R = { "<cmd>lua require 'gitsigns'.reset_buffer()<cr>", "Reset Buffer" },
  118. s = { "<cmd>lua require 'gitsigns'.stage_hunk()<cr>", "Stage Hunk" },
  119. u = {
  120. "<cmd>lua require 'gitsigns'.undo_stage_hunk()<cr>",
  121. "Undo Stage Hunk",
  122. },
  123. o = { "<cmd>Telescope git_status<cr>", "Open changed file" },
  124. b = { "<cmd>Telescope git_branches<cr>", "Checkout branch" },
  125. c = { "<cmd>Telescope git_commits<cr>", "Checkout commit" },
  126. C = {
  127. "<cmd>Telescope git_bcommits<cr>",
  128. "Checkout commit(for current file)",
  129. },
  130. d = {
  131. "<cmd>Gitsigns diffthis HEAD<cr>",
  132. "Git Diff",
  133. },
  134. },
  135. l = {
  136. name = "LSP",
  137. a = { "<cmd>lua vim.lsp.buf.code_action()<cr>", "Code Action" },
  138. d = {
  139. "<cmd>Telescope lsp_document_diagnostics<cr>",
  140. "Document Diagnostics",
  141. },
  142. w = {
  143. "<cmd>Telescope lsp_workspace_diagnostics<cr>",
  144. "Workspace Diagnostics",
  145. },
  146. -- f = { "<cmd>silent FormatWrite<cr>", "Format" },
  147. f = { "<cmd>lua vim.lsp.buf.formatting()<cr>", "Format" },
  148. i = { "<cmd>LspInfo<cr>", "Info" },
  149. j = {
  150. "<cmd>lua vim.lsp.diagnostic.goto_next({popup_opts = {border = lvim.lsp.popup_border}})<cr>",
  151. "Next Diagnostic",
  152. },
  153. k = {
  154. "<cmd>lua vim.lsp.diagnostic.goto_prev({popup_opts = {border = lvim.lsp.popup_border}})<cr>",
  155. "Prev Diagnostic",
  156. },
  157. p = {
  158. name = "Peek",
  159. d = { "<cmd>lua require('lsp.peek').Peek('definition')<cr>", "Definition" },
  160. t = { "<cmd>lua require('lsp.peek').Peek('typeDefinition')<cr>", "Type Definition" },
  161. i = { "<cmd>lua require('lsp.peek').Peek('implementation')<cr>", "Implementation" },
  162. },
  163. q = { "<cmd>lua vim.lsp.diagnostic.set_loclist()<cr>", "Quickfix" },
  164. r = { "<cmd>lua vim.lsp.buf.rename()<cr>", "Rename" },
  165. s = { "<cmd>Telescope lsp_document_symbols<cr>", "Document Symbols" },
  166. S = {
  167. "<cmd>Telescope lsp_dynamic_workspace_symbols<cr>",
  168. "Workspace Symbols",
  169. },
  170. },
  171. L = {
  172. name = "+LunarVim",
  173. c = {
  174. "<cmd>edit ~/.config/lvim/config.lua<cr>",
  175. "Edit config.lua",
  176. },
  177. f = {
  178. "<cmd>lua require('core.telescope').find_lunarvim_files()<cr>",
  179. "Find LunarVim files",
  180. },
  181. g = {
  182. "<cmd>lua require('core.telescope').grep_lunarvim_files()<cr>",
  183. "Grep LunarVim files",
  184. },
  185. k = { "<cmd>lua require('keymappings').print()<cr>", "View LunarVim's default keymappings" },
  186. i = {
  187. "<cmd>lua require('core.info').toggle_popup(vim.bo.filetype)<cr>",
  188. "Toggle LunarVim Info",
  189. },
  190. l = {
  191. name = "+logs",
  192. d = {
  193. "<cmd>lua require('core.terminal').toggle_log_view('lunarvim')<cr>",
  194. "view default log",
  195. },
  196. D = { "<cmd>edit ~/.cache/nvim/lunarvim.log<cr>", "Open the default logfile" },
  197. n = { "<cmd>lua require('core.terminal').toggle_log_view('lsp')<cr>", "view lsp log" },
  198. N = { "<cmd>edit ~/.cache/nvim/log<cr>", "Open the Neovim logfile" },
  199. l = { "<cmd>lua require('core.terminal').toggle_log_view('nvim')<cr>", "view neovim log" },
  200. L = { "<cmd>edit ~/.cache/nvim/lsp.log<cr>", "Open the LSP logfile" },
  201. p = {
  202. "<cmd>lua require('core.terminal').toggle_log_view('packer.nvim')<cr>",
  203. "view packer log",
  204. },
  205. P = { "<cmd>edit ~/.cache/nvim/packer.nvim.log<cr>", "Open the Packer logfile" },
  206. },
  207. },
  208. s = {
  209. name = "Search",
  210. b = { "<cmd>Telescope git_branches<cr>", "Checkout branch" },
  211. c = { "<cmd>Telescope colorscheme<cr>", "Colorscheme" },
  212. f = { "<cmd>Telescope find_files<cr>", "Find File" },
  213. h = { "<cmd>Telescope help_tags<cr>", "Find Help" },
  214. M = { "<cmd>Telescope man_pages<cr>", "Man Pages" },
  215. r = { "<cmd>Telescope oldfiles<cr>", "Open Recent File" },
  216. R = { "<cmd>Telescope registers<cr>", "Registers" },
  217. t = { "<cmd>Telescope live_grep<cr>", "Text" },
  218. k = { "<cmd>Telescope keymaps<cr>", "Keymaps" },
  219. C = { "<cmd>Telescope commands<cr>", "Commands" },
  220. p = {
  221. "<cmd>lua require('telescope.builtin.internal').colorscheme({enable_preview = true})<cr>",
  222. "Colorscheme with Preview",
  223. },
  224. },
  225. T = {
  226. name = "Treesitter",
  227. i = { ":TSConfigInfo<cr>", "Info" },
  228. },
  229. },
  230. }
  231. end
  232. M.setup = function()
  233. local which_key = require "which-key"
  234. which_key.setup(lvim.builtin.which_key.setup)
  235. local opts = lvim.builtin.which_key.opts
  236. local vopts = lvim.builtin.which_key.vopts
  237. local mappings = lvim.builtin.which_key.mappings
  238. local vmappings = lvim.builtin.which_key.vmappings
  239. which_key.register(mappings, opts)
  240. which_key.register(vmappings, vopts)
  241. if lvim.builtin.which_key.on_config_done then
  242. lvim.builtin.which_key.on_config_done(which_key)
  243. end
  244. end
  245. return M