NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-04-03 11:31:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

modules: clean up descriptions for colorizer & surround; add lazyload events to surround

Browse source
This commit is contained in:
raf 2025-03-16 20:11:11 +03:00
parent b3d5964237
commit ed2ce4bd02
No known key found for this signature in database
GPG key ID: 29D95B64378DB4BF
3 changed files with 24 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
modules/plugins/ui/colorizer/colorizer.nix
View file

@ -102,11 +102,7 @@ in {
setupOpts = mkPluginSetupOption "colorizer" { setupOpts = mkPluginSetupOption "colorizer" {
filetypes = mkOption { filetypes = mkOption {
description = '' type = attrsOf settingSubmodule;
Filetypes to enable on and their option overrides.
"*" means enable on all filetypes. Filetypes prefixed with "!" are disabled.
'';
default = {}; default = {};
example = { example = {
"*" = {}; "*" = {};
@ -115,13 +111,21 @@ in {
AARRGGBB = false; AARRGGBB = false;
}; };
}; };
type = attrsOf settingSubmodule; description = ''
Filetypes to enable on and their option overrides.
`"*"` means enable on all filetypes. Filetypes prefixed with `"!"` are disabled.
'';
}; };
user_default_options = mkOption { user_default_options = mkOption {
description = "Default options";
default = {};
type = settingSubmodule; type = settingSubmodule;
default = {};
description = ''
`user_default_options` is the second parameter to nvim-colorizer's setup function.
Anything set here is the inverse of the previous setup configuration.
'';
}; };
}; };
}; };

3
modules/plugins/utility/surround/config.nix
View file

@ -14,10 +14,11 @@ in {
vim = { vim = {
lazy.plugins.nvim-surround = { lazy.plugins.nvim-surround = {
package = "nvim-surround"; package = "nvim-surround";
setupModule = "nvim-surround"; setupModule = "nvim-surround";
inherit (cfg) setupOpts; inherit (cfg) setupOpts;
event = ["BufReadPre" "BufNewFile"];
keys = [ keys = [
(mkLznKey "i" cfg.setupOpts.keymaps.insert) (mkLznKey "i" cfg.setupOpts.keymaps.insert)
(mkLznKey "i" cfg.setupOpts.keymaps.insert_line) (mkLznKey "i" cfg.setupOpts.keymaps.insert_line)

14
modules/plugins/utility/surround/surround.nix
View file

@ -37,9 +37,13 @@ in {
type = bool; type = bool;
default = false; default = false;
description = '' description = ''
nvim-surround: add/change/delete surrounding delimiter pairs with ease. Whether to enable nvim-surround, Neovim plugin to add/change/delete
Note that the default mappings deviate from upstream to avoid conflicts surrounding delimiter pairs with ease.
with nvim-leap.
::: {.note}
The default mappings deviate from upstream to avoid conflicts with nvim-leap.
You may change thsoe in your configuration if you do not use nvim-leap
:::
''; '';
}; };
setupOpts = mkPluginSetupOption "nvim-surround" { setupOpts = mkPluginSetupOption "nvim-surround" {
@ -61,7 +65,9 @@ in {
useVendoredKeybindings = mkOption { useVendoredKeybindings = mkOption {
type = bool; type = bool;
default = true; default = true;
description = "Use alternative set of keybindings that avoids conflicts with other popular plugins, e.g. nvim-leap"; description = ''
Use alternative set of keybindings that avoids conflicts with other popular plugins, e.g. nvim-leap
'';
}; };
}; };
} }