mirror of
https://github.com/nix-community/nixvim.git
synced 2025-07-09 16:54:36 +02:00
plugins/nvim-ufo: init + test (#446)
This commit is contained in:
parent
58ccb99e2d
commit
794356625c
3 changed files with 155 additions and 0 deletions
82
plugins/utils/nvim-ufo.nix
Normal file
82
plugins/utils/nvim-ufo.nix
Normal file
|
@ -0,0 +1,82 @@
|
|||
{
|
||||
pkgs,
|
||||
config,
|
||||
lib,
|
||||
...
|
||||
}:
|
||||
with lib; let
|
||||
cfg = config.plugins.nvim-ufo;
|
||||
helpers = import ../helpers.nix {inherit lib;};
|
||||
in {
|
||||
options.plugins.nvim-ufo =
|
||||
helpers.extraOptionsOptions
|
||||
// {
|
||||
enable = mkEnableOption "nvim-ufo";
|
||||
|
||||
package = helpers.mkPackageOption "nvim-ufo" pkgs.vimPlugins.nvim-ufo;
|
||||
|
||||
openFoldHlTimeout = helpers.defaultNullOpts.mkInt 400 ''
|
||||
Time in millisecond between the range to be highlgihted and to be cleared
|
||||
while opening the folded line, `0` value will disable the highlight
|
||||
'';
|
||||
|
||||
providerSelector = helpers.defaultNullOpts.mkStr "null" ''
|
||||
A lua function as a selector for fold providers.
|
||||
'';
|
||||
|
||||
closeFoldKinds = helpers.mkNullOrOption types.attrs ''
|
||||
After the buffer is displayed (opened for the first time), close the
|
||||
folds whose range with `kind` field is included in this option. For now,
|
||||
'lsp' provider's standardized kinds are 'comment', 'imports' and 'region',
|
||||
run `UfoInspect` for details if your provider has extended the kinds.
|
||||
'';
|
||||
|
||||
foldVirtTextHandler = helpers.defaultNullOpts.mkStr "null" "A lua function to customize fold virtual text";
|
||||
|
||||
enableGetFoldVirtText = helpers.defaultNullOpts.mkBool false ''
|
||||
Enable a function with `lnum` as a parameter to capture the virtual text
|
||||
for the folded lines and export the function to `get_fold_virt_text` field of
|
||||
ctx table as 6th parameter in `fold_virt_text_handler`
|
||||
'';
|
||||
|
||||
preview = {
|
||||
winConfig = {
|
||||
border =
|
||||
helpers.defaultNullOpts.mkNullable (types.either types.str (types.listOf types.str)) "rounded"
|
||||
"The border for preview window, `:h nvim_open_win() | call search('border:')`";
|
||||
|
||||
winblend = helpers.defaultNullOpts.mkInt 12 "The winblend for preview window, `:h winblend`";
|
||||
|
||||
winhighlight = helpers.defaultNullOpts.mkStr "Normal:Normal" "The winhighlight for preview window, `:h winhighlight`";
|
||||
|
||||
maxheight = helpers.defaultNullOpts.mkInt 20 "The max height of preview window";
|
||||
};
|
||||
|
||||
mappings = helpers.mkNullOrOption types.attrs "Mappings for preview window";
|
||||
};
|
||||
};
|
||||
|
||||
config = let
|
||||
options = with cfg;
|
||||
{
|
||||
open_fold_hl_timeout = openFoldHlTimeout;
|
||||
provider_selector = helpers.ifNonNull' providerSelector (helpers.mkRaw providerSelector);
|
||||
close_fold_kinds = closeFoldKinds;
|
||||
fold_virt_text_handler = helpers.ifNonNull' foldVirtTextHandler (helpers.mkRaw foldVirtTextHandler);
|
||||
enable_get_fold_virt_text = enableGetFoldVirtText;
|
||||
|
||||
preview = with preview; {
|
||||
inherit mappings;
|
||||
win_config = winConfig;
|
||||
};
|
||||
}
|
||||
// cfg.extraOptions;
|
||||
in
|
||||
mkIf cfg.enable {
|
||||
extraPlugins = [cfg.package];
|
||||
|
||||
extraConfigLua = ''
|
||||
require("ufo").setup(${helpers.toLuaObject options})
|
||||
'';
|
||||
};
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue