diff --git a/doc/sense.txt b/doc/sense.txt index 088546d..c26d5af 100644 --- a/doc/sense.txt +++ b/doc/sense.txt @@ -25,7 +25,34 @@ sense.nvim configuration *sense.config* < + *vim.g.sense_nvim* + *g:sense_nvim* sense.Opts *sense.Opts* + Fields: ~ + {presets?} (sense.Opts.Presets) Preset components config + + +sense.Opts.Presets *sense.Opts.Presets* + + Fields: ~ + {virtualtext?} (sense.Opts.Presets.VirtualText) Config for diagnostic virtualtest component + {statuscolumn?} (sense.Opts.Presets.StatusColumn) Config for diagnotics statuscolumn component + + +sense.Opts.Presets.VirtualText *sense.Opts.Presets.VirtualText* + + Fields: ~ + {enabled} (boolean) Enable diagnostic virtualtext component + {max_width} (number) Max width of virtualtext component. + Setting this to lower than 1 will be treated as ratio of max width based on + the window it is attached to. + + +sense.Opts.Presets.StatusColumn *sense.Opts.Presets.StatusColumn* + + Fields: ~ + {enabeld} (boolean) Enable diagnostic statuscolumn component + vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/lua/sense/config/init.lua b/lua/sense/config/init.lua index 67c0bb6..0d3685f 100644 --- a/lua/sense/config/init.lua +++ b/lua/sense/config/init.lua @@ -19,14 +19,15 @@ local config ---@tag vim.g.sense_nvim ---@tag g:sense_nvim ---@class sense.Opts +---Preset components config ---@field presets? sense.Opts.Presets ----Preset components config ---@class sense.Opts.Presets +---Config for diagnostic virtualtest component ---@field virtualtext? sense.Opts.Presets.VirtualText +---Config for diagnotics statuscolumn component ---@field statuscolumn? sense.Opts.Presets.StatusColumn ----Config for diagnostic virtualtest component ---@class sense.Opts.Presets.VirtualText ---Enable diagnostic virtualtext component ---@field enabled boolean @@ -35,7 +36,6 @@ local config ---the window it is attached to. ---@field max_width number ----Config for diagnotics statuscolumn component ---@class sense.Opts.Presets.StatusColumn ---Enable diagnostic statuscolumn component ---@field enabeld boolean