boltless.me
Expand your neovim sense with small UI components
docs: sync readme default config
author
Seongmin Lee
date
(Feb 20, 2025, 9:38 AM UTC)
commit
ea3fc3cc
ea3fc3ccf63eb1c66bbc87cd3466aa4d7ec42ef5
parent
ad4eb365
ad4eb36545a1f00654ba097ce2716ed8689f5d85
+36
-8
+23
README.md
+23
README.md
···
47
47
48
48
<!-- default-config:start -->
49
49
```lua
50
+
---sense.nvim default configuration
51
+
---@class sense.Config
52
+
local default_config = {
53
+
---Preset components config
54
+
---@class sense.Config.Presets
55
+
presets = {
56
+
---Config for diagnostic virtualtest component
57
+
---@class sense.Config.Presets.VirtualText
58
+
virtualtext = {
59
+
---@type boolean enable diagnostic virtualtext component
60
+
enabled = true,
61
+
---@type number max width of virtualtext component
62
+
max_width = 0.5,
63
+
},
64
+
---Config for diagnostic statuscolumn component
65
+
---@class sense.Config.Presets.StatusColumn
66
+
statuscolumn = {
67
+
---@type boolean enable diagnostic statuscolumn component
68
+
enabled = true,
69
+
},
70
+
},
71
+
_log_level = vim.log.levels.WARN,
72
+
}
50
73
```
51
74
<!-- default-config:end -->
52
75
+1
flake.nix
+1
flake.nix
+7
-3
lua/sense/config/default.lua
+7
-3
lua/sense/config/default.lua
···
1
1
---@comment default-config:start
2
+
---sense.nvim default configuration
2
3
---@class sense.Config
3
4
local default_config = {
5
+
---Preset components config
4
6
---@class sense.Config.Presets
5
7
presets = {
8
+
---Config for diagnostic virtualtest component
6
9
---@class sense.Config.Presets.VirtualText
7
10
virtualtext = {
8
-
---@type boolean
11
+
---@type boolean enable diagnostic virtualtext component
9
12
enabled = true,
10
-
---@type number
13
+
---@type number max width of virtualtext component
11
14
max_width = 0.5,
12
15
},
16
+
---Config for diagnostic statuscolumn component
13
17
---@class sense.Config.Presets.StatusColumn
14
18
statuscolumn = {
15
-
---@type boolean
19
+
---@type boolean enable diagnostic statuscolumn component
16
20
enabled = true,
17
21
},
18
22
},
+4
-4
lua/sense/config/init.lua
+4
-4
lua/sense/config/init.lua
···
29
29
---@field statuscolumn? sense.Opts.Presets.StatusColumn
30
30
31
31
---@class sense.Opts.Presets.VirtualText
32
-
---Enable diagnostic virtualtext component
32
+
---Enable diagnostic virtualtext component (Default: true)
33
33
---@field enabled boolean
34
34
---Max width of virtualtext component.
35
35
---Setting this to lower than 1 will be treated as ratio of max width based on
36
-
---the window it is attached to.
36
+
---the window it is attached to. (Default: 0.5)
37
37
---@field max_width number
38
38
39
39
---@class sense.Opts.Presets.StatusColumn
40
-
---Enable diagnostic statuscolumn component
41
-
---@field enabeld boolean
40
+
---Enable diagnostic statuscolumn component (Default: true)
41
+
---@field enabled boolean
42
42
43
43
---@type sense.Opts
44
44
vim.g.sense_nvim = vim.g.sense_nvim
+1
-1
nix/test-overlay.nix
+1
-1
nix/test-overlay.nix