wrapper/rc: document vim.globals better

This commit is contained in:
raf 2024-04-21 05:19:51 +03:00
parent 72a5e6c684
commit 50609c731e
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
2 changed files with 14 additions and 2 deletions

View file

@ -81,6 +81,8 @@ inputs: {
optional = false; optional = false;
}) (buildConfigPlugins vimOptions.optPlugins); }) (buildConfigPlugins vimOptions.optPlugins);
# combine built start and optional plugins
# into a single list
plugins = builtStartPlugins ++ builtOptPlugins; plugins = builtStartPlugins ++ builtOptPlugins;
# additional Lua and Python3 packages, mapped to their respective functions # additional Lua and Python3 packages, mapped to their respective functions

View file

@ -70,9 +70,19 @@ in {
}; };
globals = mkOption { globals = mkOption {
default = {};
type = attrs; type = attrs;
description = "Set containing global variable values"; default = {};
description = ''
An attribute set containing global variable values
for storing vim variables as early as possible. If
populated, this soption will set vim variables in the
built configRC as the first item.
E.g. {foo = "bar"} will set `g:foo` to "bar" where
the type of `bar` in the resulting vimscript will be
infered from the type of the value in the `{name = value}`
pair.
'';
}; };
configRC = mkOption { configRC = mkOption {