Skip to content

Commit 0ea771b

Browse files
folkefolke
committed
feat(ui): made all highlight groups and icons configurable
1 parent 3d22c49 commit 0ea771b

File tree

5 files changed

+108
-78
lines changed

5 files changed

+108
-78
lines changed

‎README.md

+38-23
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,8 @@ return {
315315
-- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
316316
border = "none",
317317
icons = {
318+
loaded = "●",
319+
not_loaded = "○",
318320
cmd = "",
319321
config = "",
320322
event = "",
@@ -327,6 +329,12 @@ return {
327329
start = "",
328330
task = "✔ ",
329331
lazy = "鈴 ",
332+
list = {
333+
"●",
334+
"➜",
335+
"★",
336+
"‒",
337+
},
330338
},
331339
throttle = 20, -- how frequently should the ui process render events
332340
custom_keys = {
@@ -666,29 +674,36 @@ To uninstall **lazy.nvim**, you need to remove the following files and directori
666674

667675
<!-- colors:start -->
668676

669-
| Highlight Group | Default Group | Description |
670-
| ---------------------- | -------------------------- | ----------------- |
671-
| **LazyButton** | **_CursorLine_** | |
672-
| **LazyButtonActive** | **_Visual_** | |
673-
| **LazyCommit** | **_@variable.builtin_** | |
674-
| **LazyError** | **_ErrorMsg_** | task errors |
675-
| **LazyH1** | **_IncSearch_** | |
676-
| **LazyH2** | **_Bold_** | |
677-
| **LazyHandlerCmd** | **_Operator_** | |
678-
| **LazyHandlerEvent** | **_Constant_** | |
679-
| **LazyHandlerFt** | **_Character_** | |
680-
| **LazyHandlerKeys** | **_Statement_** | |
681-
| **LazyHandlerPlugin** | **_Special_** | |
682-
| **LazyHandlerRuntime** | **_@macro_** | |
683-
| **LazyHandlerSource** | **_Character_** | |
684-
| **LazyHandlerStart** | **_@field_** | |
685-
| **LazyKey** | **_Conceal_** | |
686-
| **LazyMuted** | **_Comment_** | |
687-
| **LazyNormal** | **_NormalFloat_** | |
688-
| **LazyProgressDone** | **_Constant_** | progress bar done |
689-
| **LazyProgressTodo** | **_LineNr_** | progress bar todo |
690-
| **LazySpecial** | **_@punctuation.special_** | |
691-
| **LazyValue** | **_@string_** | |
677+
| Highlight Group | Default Group | Description |
678+
| --------------------- | -------------------------- | --------------------------------------------------- |
679+
| **LazyButton** | **_CursorLine_** | |
680+
| **LazyButtonActive** | **_Visual_** | |
681+
| **LazyComment** | **_Comment_** | |
682+
| **LazyCommit** | **_@variable.builtin_** | commit ref |
683+
| **LazyCommitIssue** | **_Number_** | |
684+
| **LazyCommitScope** | **_Italic_** | conventional commit scope |
685+
| **LazyCommitType** | **_Title_** | conventional commit type |
686+
| **LazyDir** | **_@text.reference_** | directory |
687+
| **LazyH1** | **_IncSearch_** | home button |
688+
| **LazyH2** | **_Bold_** | titles |
689+
| **LazyNoCond** | **_DiagnosticWarn_** | unloaded icon for a plugin where `cond()` was false |
690+
| **LazyNormal** | **_NormalFloat_** | |
691+
| **LazyProgressDone** | **_Constant_** | progress bar done |
692+
| **LazyProgressTodo** | **_LineNr_** | progress bar todo |
693+
| **LazyProp** | **_Conceal_** | property |
694+
| **LazyReasonCmd** | **_Operator_** | |
695+
| **LazyReasonEvent** | **_Constant_** | |
696+
| **LazyReasonFt** | **_Character_** | |
697+
| **LazyReasonKeys** | **_Statement_** | |
698+
| **LazyReasonPlugin** | **_Special_** | |
699+
| **LazyReasonRuntime** | **_@macro_** | |
700+
| **LazyReasonSource** | **_Character_** | |
701+
| **LazyReasonStart** | **_@field_** | |
702+
| **LazySpecial** | **_@punctuation.special_** | |
703+
| **LazyTaskError** | **_ErrorMsg_** | task errors |
704+
| **LazyTaskOutput** | **_MsgArea_** | task output |
705+
| **LazyUrl** | **_@text.reference_** | url |
706+
| **LazyValue** | **_@string_** | value of a property |
692707

693708
<!-- colors:end -->
694709

‎lua/lazy/core/config.lua

+8
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ M.defaults = {
3737
-- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
3838
border = "none",
3939
icons = {
40+
loaded = "●",
41+
not_loaded = "○",
4042
cmd = "",
4143
config = "",
4244
event = "",
@@ -49,6 +51,12 @@ M.defaults = {
4951
start = "",
5052
task = "✔ ",
5153
lazy = "鈴 ",
54+
list = {
55+
"●",
56+
"➜",
57+
"★",
58+
"‒",
59+
},
5260
},
5361
throttle = 20, -- how frequently should the ui process render events
5462
custom_keys = {

‎lua/lazy/view/colors.lua

+22-16
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
11
local M = {}
22

33
M.colors = {
4-
Error = "ErrorMsg", -- task errors
5-
H1 = "IncSearch",
6-
H2 = "Bold",
7-
Muted = "Comment",
4+
H1 = "IncSearch", -- home button
5+
H2 = "Bold", -- titles
6+
Comment = "Comment",
87
Normal = "NormalFloat",
9-
Commit = "@variable.builtin",
10-
Key = "Conceal",
11-
Value = "@string",
12-
NoCond = "DiagnosticError",
8+
Commit = "@variable.builtin", -- commit ref
9+
CommitIssue = "Number",
10+
CommitType = "Title", -- conventional commit type
11+
CommitScope = "Italic", -- conventional commit scope
12+
Prop = "Conceal", -- property
13+
Value = "@string", -- value of a property
14+
NoCond = "DiagnosticWarn", -- unloaded icon for a plugin where `cond()` was false
1315
ProgressDone = "Constant", -- progress bar done
1416
ProgressTodo = "LineNr", -- progress bar todo
1517
Special = "@punctuation.special",
16-
HandlerRuntime = "@macro",
17-
HandlerPlugin = "Special",
18-
HandlerEvent = "Constant",
19-
HandlerKeys = "Statement",
20-
HandlerStart = "@field",
21-
HandlerSource = "Character",
22-
HandlerFt = "Character",
23-
HandlerCmd = "Operator",
18+
ReasonRuntime = "@macro",
19+
ReasonPlugin = "Special",
20+
ReasonEvent = "Constant",
21+
ReasonKeys = "Statement",
22+
ReasonStart = "@field",
23+
ReasonSource = "Character",
24+
ReasonFt = "Character",
25+
ReasonCmd = "Operator",
2426
Button = "CursorLine",
2527
ButtonActive = "Visual",
28+
TaskOutput = "MsgArea", -- task output
29+
TaskError = "ErrorMsg", -- task errors
30+
Dir = "@text.reference", -- directory
31+
Url = "@text.reference", -- url
2632
}
2733

2834
M.did_setup = false

‎lua/lazy/view/float.lua

+5
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ function M:mount()
7777
end
7878

7979
---@class LazyViewWinOpts
80+
---@field width number
81+
---@field height number
82+
---@field row number
83+
---@field col number
8084
local win_opts = {
8185
relative = "editor",
8286
style = "minimal",
@@ -111,6 +115,7 @@ function M:mount()
111115
self:layout()
112116
local config = {}
113117
for _, key in ipairs({ "relative", "width", "height", "col", "row" }) do
118+
---@diagnostic disable-next-line: no-unknown
114119
config[key] = self.opts.win_opts[key]
115120
end
116121
vim.api.nvim_win_set_config(self.win, config)

‎lua/lazy/view/render.lua

+35-39
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,10 @@ function M:title()
141141
if self.view.state.mode ~= "help" and self.view.state.mode ~= "profile" and self.view.state.mode ~= "debug" then
142142
if self.progress.done < self.progress.total then
143143
self:append("Tasks: ", "LazyH2")
144-
self:append(self.progress.done .. "/" .. self.progress.total, "LazyMuted")
144+
self:append(self.progress.done .. "/" .. self.progress.total, "LazyComment")
145145
else
146146
self:append("Total: ", "LazyH2")
147-
self:append(#self.plugins .. " plugins", "LazyMuted")
147+
self:append(#self.plugins .. " plugins", "LazyComment")
148148
end
149149
self:nl():nl()
150150
end
@@ -174,7 +174,7 @@ function M:help()
174174
self:append("- ", "LazySpecial", { indent = 2 })
175175
self:append(title, "Title")
176176
if mode.key then
177-
self:append(" <" .. mode.key .. ">", "LazyKey")
177+
self:append(" <" .. mode.key .. ">", "LazyProp")
178178
end
179179
self:append(" " .. (mode.desc or "")):nl()
180180
end
@@ -187,7 +187,7 @@ function M:help()
187187
self:append("- ", "LazySpecial", { indent = 2 })
188188
self:append(title, "Title")
189189
if mode.key_plugin then
190-
self:append(" <" .. mode.key_plugin .. ">", "LazyKey")
190+
self:append(" <" .. mode.key_plugin .. ">", "LazyProp")
191191
end
192192
self:append(" " .. (mode.desc_plugin or mode.desc)):nl()
193193
end
@@ -225,7 +225,7 @@ function M:section(section)
225225

226226
local count = #section_plugins
227227
if count > 0 then
228-
self:append(section.title, "LazyH2"):append(" (" .. count .. ")", "LazyMuted"):nl()
228+
self:append(section.title, "LazyH2"):append(" (" .. count .. ")", "LazyComment"):nl()
229229
for _, plugin in ipairs(section_plugins) do
230230
self:plugin(plugin)
231231
end
@@ -306,21 +306,20 @@ function M:reason(reason, opts)
306306
if key == "keys" then
307307
value = type(value) == "string" and value or value[1]
308308
end
309-
local hl = "LazyHandler" .. key:sub(1, 1):upper() .. key:sub(2)
309+
local hl = "LazyReason" .. key:sub(1, 1):upper() .. key:sub(2)
310310
local icon = Config.options.ui.icons[key]
311311
if icon then
312312
self:append(icon .. " ", hl)
313313
self:append(value, hl)
314314
else
315-
self:append(key .. " ", "@field")
315+
self:append(key .. " ", hl)
316316
self:append(value, hl)
317317
end
318318
end
319319
end
320320
if time and opts.time_right then
321321
self:append(time, "Bold")
322322
end
323-
-- self:append(")", "Conceal")
324323
end
325324

326325
---@param plugin LazyPlugin
@@ -358,11 +357,11 @@ end
358357
---@param plugin LazyPlugin
359358
function M:plugin(plugin)
360359
if plugin._.loaded then
361-
self:append(" ● ", "LazySpecial"):append(plugin.name)
360+
self:append(" " .. Config.options.ui.icons.loaded .. " ", "LazySpecial"):append(plugin.name)
362361
elseif plugin._.cond == false then
363-
self:append(" ○ ", "LazyNoCond"):append(plugin.name)
362+
self:append(" " .. Config.options.ui.icons.not_loaded .. " ", "LazyNoCond"):append(plugin.name)
364363
else
365-
self:append(" ○ ", "LazySpecial"):append(plugin.name)
364+
self:append(" " .. Config.options.ui.icons.not_loaded .. " ", "LazySpecial"):append(plugin.name)
366365
end
367366
local plugin_start = self:row()
368367
if plugin._.loaded then
@@ -382,22 +381,19 @@ end
382381
---@param plugin LazyPlugin
383382
function M:tasks(plugin)
384383
for _, task in ipairs(plugin._.tasks or {}) do
385-
if self.view.state.plugin == plugin.name then
386-
self:append("✔ [task] ", "Title", { indent = 4 }):append(task.name)
384+
if self.view:is_selected(plugin) then
385+
self:append(Config.options.ui.icons.task .. "[task] ", "Title", { indent = 4 }):append(task.name)
387386
self:append(" " .. math.floor((task:time()) * 100) / 100 .. "ms", "Bold")
388387
self:nl()
389388
end
390-
if task.name == "log" and not task.error then
389+
if task.error then
390+
self:append(vim.trim(task.error), "LazyTaskError", { indent = 6 })
391+
self:nl()
392+
elseif task.name == "log" then
391393
self:log(task)
392-
elseif task.error or self.view:is_selected(plugin) then
393-
if task.error then
394-
self:append(vim.trim(task.error), "LazyError", { indent = 4, prefix = "│ " })
395-
self:nl()
396-
end
397-
if task.output ~= "" and task.output ~= task.error then
398-
self:append(vim.trim(task.output), "MsgArea", { indent = 4, prefix = "│ " })
399-
self:nl()
400-
end
394+
elseif self.view:is_selected(plugin) and task.output ~= "" and task.output ~= task.error then
395+
self:append(vim.trim(task.output), "LazyTaskOutput", { indent = 6 })
396+
self:nl()
401397
end
402398
end
403399
end
@@ -414,15 +410,15 @@ function M:log(task)
414410
end
415411
self:append(ref:sub(1, 7) .. " ", "LazyCommit", { indent = 6 })
416412
self:append(vim.trim(msg)):highlight({
417-
["#%d+"] = "Number",
418-
["^%S+:"] = "Title",
419-
["^%S+(%(.*%)):"] = "Italic",
413+
["#%d+"] = "LazyCommitIssue",
414+
["^%S+:"] = "LazyCommitType",
415+
["^%S+(%(.*%)):"] = "LazyCommitScope",
420416
["`.-`"] = "@text.literal.markdown_inline",
421417
["%*.-%*"] = "Italic",
422418
["%*%*.-%*%*"] = "Bold",
423419
})
424420
-- string.gsub
425-
self:append(" " .. time, "Comment")
421+
self:append(" " .. time, "LazyComment")
426422
self:nl()
427423
end
428424
self:nl()
@@ -433,9 +429,9 @@ end
433429
function M:details(plugin)
434430
---@type string[][]
435431
local props = {}
436-
table.insert(props, { "dir", plugin.dir, "@text.reference" })
432+
table.insert(props, { "dir", plugin.dir, "LazyDir" })
437433
if plugin.url then
438-
table.insert(props, { "url", (plugin.url:gsub("%.git$", "")), "@text.reference" })
434+
table.insert(props, { "url", (plugin.url:gsub("%.git$", "")), "LazyUrl" })
439435
end
440436
local git = Git.info(plugin.dir, true)
441437
if git then
@@ -483,7 +479,7 @@ function M:details(plugin)
483479
width = math.max(width, #prop[1])
484480
end
485481
for _, prop in ipairs(props) do
486-
self:append(prop[1] .. string.rep(" ", width - #prop[1] + 1), "LazyKey", { indent = 6 })
482+
self:append(prop[1] .. string.rep(" ", width - #prop[1] + 1), "LazyProp", { indent = 6 })
487483
if type(prop[2]) == "function" then
488484
prop[2]()
489485
else
@@ -508,12 +504,6 @@ function M:profile()
508504
:nl()
509505

510506
self:nl()
511-
local symbols = {
512-
"●",
513-
"➜",
514-
"★",
515-
"‒",
516-
}
517507

518508
---@param a LazyProfile
519509
---@param b LazyProfile
@@ -543,7 +533,7 @@ function M:profile()
543533
end
544534
local data = type(entry.data) == "string" and { source = entry.data } or entry.data
545535
data.time = entry.time
546-
local symbol = symbols[depth] or symbols[#symbols]
536+
local symbol = M.list_icon(depth)
547537
self:append((" "):rep(depth)):append(symbol, "LazySpecial"):append(" ")
548538
self:reason(data, { time_right = true })
549539
self:nl()
@@ -557,12 +547,17 @@ function M:profile()
557547
end
558548
end
559549

550+
function M.list_icon(depth)
551+
local symbols = Config.options.ui.icons.list
552+
return symbols[(depth - 1) % #symbols + 1]
553+
end
554+
560555
function M:debug()
561556
self:append("Active Handlers", "LazyH2"):nl()
562557
self
563558
:append(
564559
"This shows only the lazy handlers that are still active. When a plugin loads, its handlers are removed",
565-
"Comment",
560+
"LazyComment",
566561
{ indent = 2 }
567562
)
568563
:nl()
@@ -571,6 +566,7 @@ function M:debug()
571566
Util.foreach(handler.active, function(value, plugins)
572567
value = type(value) == "table" and value[1] or value
573568
if not vim.tbl_isempty(plugins) then
569+
---@type string[]
574570
plugins = vim.tbl_values(plugins)
575571
table.sort(plugins)
576572
self:append("● ", "LazySpecial", { indent = 2 })
@@ -590,7 +586,7 @@ function M:debug()
590586
local kb = math.floor(#entry.chunk / 10.24) / 100
591587
self:append("● ", "LazySpecial", { indent = 2 }):append(modname):append(" " .. kb .. "Kb", "Bold")
592588
if entry.modpath ~= modname then
593-
self:append(" " .. vim.fn.fnamemodify(entry.modpath, ":p:~:."), "Comment")
589+
self:append(" " .. vim.fn.fnamemodify(entry.modpath, ":p:~:."), "LazyComment")
594590
end
595591
self:nl()
596592
end)

0 commit comments

Comments
 (0)