diff --git a/README.md b/README.md index 297a3b2..33fa6a3 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,29 @@ vim.g.sense_nvim = { ```lua +---sense.nvim default configuration +---@class sense.Config +local default_config = { + ---Preset components config + ---@class sense.Config.Presets + presets = { + ---Config for diagnostic virtualtest component + ---@class sense.Config.Presets.VirtualText + virtualtext = { + ---@type boolean enable diagnostic virtualtext component + enabled = true, + ---@type number max width of virtualtext component + max_width = 0.5, + }, + ---Config for diagnostic statuscolumn component + ---@class sense.Config.Presets.StatusColumn + statuscolumn = { + ---@type boolean enable diagnostic statuscolumn component + enabled = true, + }, + }, + _log_level = vim.log.levels.WARN, +} ``` diff --git a/flake.nix b/flake.nix index d24167a..50991ed 100644 --- a/flake.nix +++ b/flake.nix @@ -65,6 +65,7 @@ sumneko-lua-language-server stylua docgen + sync-readme neovim-nightly (pkgs.lua5_1.withPackages (ps: with ps; [luarocks luacheck])) ]; diff --git a/lua/sense/config/default.lua b/lua/sense/config/default.lua index 7315e40..74b0049 100644 --- a/lua/sense/config/default.lua +++ b/lua/sense/config/default.lua @@ -1,18 +1,22 @@ ---@comment default-config:start +---sense.nvim default configuration ---@class sense.Config local default_config = { + ---Preset components config ---@class sense.Config.Presets presets = { + ---Config for diagnostic virtualtest component ---@class sense.Config.Presets.VirtualText virtualtext = { - ---@type boolean + ---@type boolean enable diagnostic virtualtext component enabled = true, - ---@type number + ---@type number max width of virtualtext component max_width = 0.5, }, + ---Config for diagnostic statuscolumn component ---@class sense.Config.Presets.StatusColumn statuscolumn = { - ---@type boolean + ---@type boolean enable diagnostic statuscolumn component enabled = true, }, }, diff --git a/lua/sense/config/init.lua b/lua/sense/config/init.lua index 0d3685f..9d8684e 100644 --- a/lua/sense/config/init.lua +++ b/lua/sense/config/init.lua @@ -29,16 +29,16 @@ local config ---@field statuscolumn? sense.Opts.Presets.StatusColumn ---@class sense.Opts.Presets.VirtualText ----Enable diagnostic virtualtext component +---Enable diagnostic virtualtext component (Default: true) ---@field enabled boolean ---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. +---the window it is attached to. (Default: 0.5) ---@field max_width number ---@class sense.Opts.Presets.StatusColumn ----Enable diagnostic statuscolumn component ----@field enabeld boolean +---Enable diagnostic statuscolumn component (Default: true) +---@field enabled boolean ---@type sense.Opts vim.g.sense_nvim = vim.g.sense_nvim diff --git a/nix/test-overlay.nix b/nix/test-overlay.nix index 32d3878..7a4b862 100644 --- a/nix/test-overlay.nix +++ b/nix/test-overlay.nix @@ -77,5 +77,5 @@ in { # TODO: test with neovim v0.10.2 instead neovim-stable-test = mkNeorocksTest "neovim-stable-test" final.neovim; neovim-nightly-test = mkNeorocksTest "neovim-nightly-test" final.neovim-nightly; - inherit docgen; + inherit docgen sync-readme; }