1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
return {
{
"nvzone/showkeys",
cmd = "ShowkeysToggle",
opts = {},
keys = {
{ "<leader>zk", "<cmd>ShowkeysToggle<cr>", desc = "Toggle keys" },
},
},
{
"folke/which-key.nvim",
event = "VeryLazy",
cmd = "WhichKey",
dependencies = { "echasnovski/mini.icons", "nvim-tree/nvim-web-devicons" },
opts = {},
config = function()
local wk = require("which-key")
wk.setup({
---@type false | "classic" | "modern" | "helix"
preset = "classic",
-- Delay before showing the popup. Can be a number or a function that returns a number.
---@type number | fun(ctx: { keys: string, mode: string, plugin?: string }):number
delay = function(ctx)
return ctx.plugin and 0 or 200
end,
---@param mapping wk.Mapping
filter = function(mapping)
-- example to exclude mappings without a description
-- return mapping.desc and mapping.desc ~= ""
return true
end,
--- You can add any mappings here, or use `require('which-key').add()` later
---@type wk.Spec
spec = {},
-- show a warning when issues were detected with your mappings
notify = true,
-- Which-key automatically sets up triggers for your mappings.
-- But you can disable this and setup the triggers manually.
-- Check the docs for more info.
---@type wk.Spec
triggers = {
{ "<auto>", mode = "nxso" },
},
-- Start hidden and wait for a key to be pressed before showing the popup
-- Only used by enabled xo mapping modes.
---@param ctx { mode: string, operator: string }
defer = function(ctx)
return ctx.mode == "V" or ctx.mode == "<C-V>"
end,
plugins = {
marks = true, -- shows a list of your marks on ' and `
registers = true, -- shows your registers on " in NORMAL or <C-r> in INSERT mode
-- the presets plugin, adds help for a bunch of default keybindings in Neovim
-- No actual key bindings are created
spelling = {
enabled = true, -- enabling this will show WhichKey when pressing z= to select spelling suggestions
suggestions = 20, -- how many suggestions should be shown in the list?
},
presets = {
operators = true, -- adds help for operators like d, y, ...
motions = true, -- adds help for motions
text_objects = true, -- help for text objects triggered after entering an operator
windows = true, -- default bindings on <c-w>
nav = true, -- misc bindings to work with windows
z = true, -- bindings for folds, spelling and others prefixed with z
g = true, -- bindings for prefixed with g
},
},
---@type wk.Win.opts
win = {
-- don't allow the popup to overlap with the cursor
no_overlap = true,
-- width = 1,
-- height = { min = 4, max = 25 },
-- col = 0,
-- row = math.huge,
-- border = "none",
padding = { 1, 2 }, -- extra window padding [top/bottom, right/left]
title = true,
title_pos = "center",
zindex = 1000,
-- Additional vim.wo and vim.bo options
bo = {},
wo = {
-- winblend = 10, -- value between 0-100 0 for fully opaque and 100 for fully transparent
},
},
layout = {
width = { min = 20 }, -- min and max width of the columns
spacing = 3, -- spacing between columns
},
keys = {
scroll_down = "<c-e>",
scroll_up = "<c-y>",
},
---@type (string|wk.Sorter)[]
--- Mappings are sorted using configured sorters and natural sort of the keys
--- Available sorters:
--- * local: buffer-local mappings first
--- * order: order of the items (Used by plugins like marks / registers)
--- * group: groups last
--- * alphanum: alpha-numerical first
--- * mod: special modifier keys last
--- * manual: the order the mappings were added
--- * case: lower-case first
sort = { "local", "order", "group", "alphanum", "mod" },
---@type number|fun(node: wk.Node):boolean?
expand = 0, -- expand groups when <= n mappings
-- expand = function(node)
-- return not node.desc -- expand all nodes without a description
-- end,
-- Functions/Lua Patterns for formatting the labels
---@type table<string, ({[1]:string, [2]:string}|fun(str:string):string)[]>
replace = {
key = {
function(key)
return require("which-key.view").format(key)
end,
-- { "<Space>", "SPC" },
},
desc = {
{ "<Plug>%(?(.*)%)?", "%1" },
{ "^%+", "" },
{ "<[cC]md>", "" },
{ "<[cC][rR]>", "" },
{ "<[sS]ilent>", "" },
{ "^lua%s+", "" },
{ "^call%s+", "" },
{ "^:%s*", "" },
},
},
icons = {
breadcrumb = "»", -- symbol used in the command line area that shows your active key combo
separator = "➜", -- symbol used between a key and it's label
group = "+", -- symbol prepended to a group
ellipsis = "…",
-- set to false to disable all mapping icons,
-- both those explicitly added in a mapping
-- and those from rules
mappings = true,
--- See `lua/which-key/icons.lua` for more details
--- Set to `false` to disable keymap icons from rules
---@type wk.IconRule[]|false
rules = {},
-- use the highlights from mini.icons
-- When `false`, it will use `WhichKeyIcon` instead
colors = true,
-- used by key format
keys = {
Up = " ",
Down = " ",
Left = " ",
Right = " ",
C = " ",
M = " ",
D = " ",
S = " ",
CR = " ",
Esc = " ",
ScrollWheelDown = " ",
ScrollWheelUp = " ",
NL = " ",
BS = "",
Space = " ",
Tab = " ",
F1 = "",
F2 = "",
F3 = "",
F4 = "",
F5 = "",
F6 = "",
F7 = "",
F8 = "",
F9 = "",
F10 = "",
F11 = "",
F12 = "",
},
},
show_help = true, -- show a help message in the command line for using WhichKey
show_keys = true, -- show the currently pressed key and its label as a message in the command line
-- disable WhichKey for certain buf types and file types.
disable = {
ft = {},
bt = {},
},
debug = false, -- enable wk.log in the current directory
})
wk.add({
{
mode = { "n", "v" },
{ "g", group = "Goto" },
{ "g`", group = "Marks" },
{ "g'", group = "Marks" },
{ "gs", group = "Search/Surround" },
{ "s", group = "Surround/Search & replace on line" },
{ "S", group = "Surround/Search & replace in file" },
{ "z", group = "Fold" },
{ "`", group = "Marks" },
{ "'", group = "Marks" },
{ '"', group = "Registers" },
{ "]", group = "Next" },
{ "]]", group = "Next" },
{ "[", group = "Prev" },
{ "[[", group = "Prev" },
{ "=", group = "Line paste" },
{ "gx", desc = "Open with system app" },
{ "<C-w>", group = "Windows" },
{ "<leader>", group = "Leader" },
{ "<leader>a", group = "Ascii" },
{
"<leader>b",
group = "Buffer",
expand = function()
return require("which-key.extras").expand.buf()
end,
},
{ "<leader>B", group = "Buffer (force)" },
{ "<leader>C", group = "Goto realpath" },
{ "<leader>d", group = "Delete" },
{ "<leader>D", group = "Delete (blackhole)" },
{ "<leader>e", group = "Explorer" },
{ "<leader>i", group = "Inspect" },
{ "<leader>l", group = "Location" },
{ "<leader>L", group = "Lazy" },
{ "<leader>M", group = "Mason" },
{ "<leader>o", group = "Open" },
{ "<leader>p", group = "Paste" },
{ "<leader>P", group = "Paste" },
{ "<leader>q", group = "Quit" },
{ "<leader>sk", group = "Keys" },
{ "<leader>S", group = "Save/Source" },
{ "<leader>w", group = "Which-key" },
{ "<leader>W", group = "Save all" },
{ "<leader>z", group = "Toggle" },
{ "<leader><tab>", group = "Tabs" },
{ "<localleader>", group = "Local Leader (bookmarks)" },
{ "<localleader><leader>", group = "Bookmarks (explorer)" },
{ "<localleader><localleader>", group = "Bookmarks (mini)" },
{ "<localleader>t", group = "Task" },
},
{
mode = { "n", "v", "x" },
{ "gw", desc = "Visible in window" },
{ "g%", desc = "Match backward" },
{ "g;", desc = "Last change" },
{ "<leader>Q", group = "Quit all" },
},
})
end,
keys = {
{
"<leader>?",
function()
require("which-key").show({ global = false })
end,
desc = "Buffer local keymaps (which-key)",
},
{
"<leader>wk",
function()
local ok, input = pcall(vim.fn.input, "WhichKey: ")
if ok and input ~= "" then
vim.cmd("WhichKey " .. input)
end
end,
desc = "Which-key query lookup",
},
{
mode = { "n", "v", "x" },
"<leader>wK",
"<cmd>WhichKey<cr>",
desc = "Which-key all key",
},
},
},
}
|
