cleanup: refactor which-key configuration for cleaner setup (#1102)

- Moved `which-key` configuration from inline `config` to `opts` for better organization.
- Updated the key mappings setup to use `spec` for defining existing key chains.
- Removed deprecated or unnecessary comments and code.

This change aligns with updated `which-key` configuration practices, improving readability and maintainability as recommended by @VlaDexa in #1068.
This commit is contained in:
Ihsan Tonuzi 2024-08-26 12:17:22 -04:00 committed by GitHub
parent c76c323a7c
commit 24d368f9ff
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -274,57 +274,55 @@ require('lazy').setup({
{ -- Useful plugin to show you pending keybinds. { -- Useful plugin to show you pending keybinds.
'folke/which-key.nvim', 'folke/which-key.nvim',
event = 'VimEnter', -- Sets the loading event to 'VimEnter' event = 'VimEnter', -- Sets the loading event to 'VimEnter'
config = function() -- This is the function that runs, AFTER loading opts = {
require('which-key').setup { icons = {
icons = { -- set icon mappings to true if you have a Nerd Font
-- set icon mappings to true if you have a Nerd Font mappings = vim.g.have_nerd_font,
mappings = vim.g.have_nerd_font, -- If you are using a Nerd Font: set icons.keys to an empty table which will use the
-- If you are using a Nerd Font: set icons.keys to an empty table which will use the -- default whick-key.nvim defined Nerd Font icons, otherwise define a string table
-- default whick-key.nvim defined Nerd Font icons, otherwise define a string table keys = vim.g.have_nerd_font and {} or {
keys = vim.g.have_nerd_font and {} or { Up = '<Up> ',
Up = '<Up> ', Down = '<Down> ',
Down = '<Down> ', Left = '<Left> ',
Left = '<Left> ', Right = '<Right> ',
Right = '<Right> ', C = '<C-…> ',
C = '<C-…> ', M = '<M-…> ',
M = '<M-…> ', D = '<D-…> ',
D = '<D-…> ', S = '<S-…> ',
S = '<S-…> ', CR = '<CR> ',
CR = '<CR> ', Esc = '<Esc> ',
Esc = '<Esc> ', ScrollWheelDown = '<ScrollWheelDown> ',
ScrollWheelDown = '<ScrollWheelDown> ', ScrollWheelUp = '<ScrollWheelUp> ',
ScrollWheelUp = '<ScrollWheelUp> ', NL = '<NL> ',
NL = '<NL> ', BS = '<BS> ',
BS = '<BS> ', Space = '<Space> ',
Space = '<Space> ', Tab = '<Tab> ',
Tab = '<Tab> ', F1 = '<F1>',
F1 = '<F1>', F2 = '<F2>',
F2 = '<F2>', F3 = '<F3>',
F3 = '<F3>', F4 = '<F4>',
F4 = '<F4>', F5 = '<F5>',
F5 = '<F5>', F6 = '<F6>',
F6 = '<F6>', F7 = '<F7>',
F7 = '<F7>', F8 = '<F8>',
F8 = '<F8>', F9 = '<F9>',
F9 = '<F9>', F10 = '<F10>',
F10 = '<F10>', F11 = '<F11>',
F11 = '<F11>', F12 = '<F12>',
F12 = '<F12>',
},
}, },
}
-- Document existing key chains -- Document existing key chains
require('which-key').add { spec = {
{ '<leader>c', group = '[C]ode', mode = { 'n', 'x' } }, { '<leader>c', group = '[C]ode', mode = { 'n', 'x' } },
{ '<leader>d', group = '[D]ocument' }, { '<leader>d', group = '[D]ocument' },
{ '<leader>r', group = '[R]ename' }, { '<leader>r', group = '[R]ename' },
{ '<leader>s', group = '[S]earch' }, { '<leader>s', group = '[S]earch' },
{ '<leader>w', group = '[W]orkspace' }, { '<leader>w', group = '[W]orkspace' },
{ '<leader>t', group = '[T]oggle' }, { '<leader>t', group = '[T]oggle' },
{ '<leader>h', group = 'Git [H]unk', mode = { 'n', 'v' } }, { '<leader>h', group = 'Git [H]unk', mode = { 'n', 'v' } },
} },
end, },
},
}, },
-- NOTE: Plugins can specify dependencies. -- NOTE: Plugins can specify dependencies.