mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-22 08:53:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

misc: ensure all options have a description

Browse source
This commit is contained in:
Gaetan Lepage 2024-06-09 23:04:27 +02:00 • committed by Gaétan Lepage
parent 3be9db71c2
commit 7a2d065cce
13 changed files with 127 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

4
plugins/utils/hydra/hydras-option.nix
View file

@ -112,6 +112,10 @@ in
mkOption {
type = types.listOf hydraType;
default = [ ];
description = ''
A list of hydra configurations.
See [here](https://github.com/nvimtools/hydra.nvim?tab=readme-ov-file#creating-a-new-hydra).
'';
example = [
{
name = "git";

17
plugins/utils/nix-develop.nix
View file

@ -16,13 +16,26 @@ in
package = helpers.mkPluginPackageOption "nix-develop.nvim" pkgs.vimPlugins.nix-develop-nvim;
ignoredVariables = mkOption {
type = types.attrsOf types.bool;
type = with types; attrsOf bool;
default = { };
description = "An attrs specifying the variables should be ignored.";
example = {
BASHOPTS = true;
HOME = true;
NIX_BUILD_TOP = true;
SHELL = true;
TMP = true;
};
};
separatedVariables = mkOption {
type = types.attrsOf types.str;
type = with types; attrsOf str;
default = { };
description = "An attrs specifying the separator to use for particular environment variables.";
example = {
PATH = ":";
XDG_DATA_DIRS = ":";
};
};
};

28
plugins/utils/nvim-colorizer.nix
View file

@ -108,18 +108,22 @@ in
fileTypes = mkOption {
description = "Enable and/or configure highlighting for certain filetypes";
type = types.nullOr (
types.listOf (
types.oneOf [
types.str
(types.submodule {
options = {
language = mkOption { type = types.str; };
} // colorizer-options;
})
]
)
);
type =
with types;
nullOr (
listOf (
either str (
types.submodule {
options = {
language = mkOption {
type = types.str;
description = "The language this configuration should apply to.";
};
} // colorizer-options;
}
)
)
);
default = null;
};

45
plugins/utils/which-key.nix
View file

@ -69,12 +69,21 @@ with lib;
window =
let
spacingOptions = types.submodule {
options = {
top = mkOption { type = types.int; };
right = mkOption { type = types.int; };
bottom = mkOption { type = types.int; };
left = mkOption { type = types.int; };
};
options =
genAttrs
[
"top"
"right"
"bottom"
"left"
]
(
n:
mkOption {
type = types.ints.unsigned;
description = "Spacing at the ${n}.";
}
);
};
in
{
@ -98,18 +107,26 @@ with lib;
let
rangeOption = types.submodule {
options = {
min = mkOption { type = types.int; };
max = mkOption { type = types.int; };
min = mkOption {
type = types.int;
description = "Minimum size.";
};
max = mkOption {
type = types.int;
description = "Maximum size.";
};
};
};
in
{
height =
helpers.defaultNullOpts.mkNullable rangeOption "{min = 4; max = 25;}"
"min and max height of the columns";
width =
helpers.defaultNullOpts.mkNullable rangeOption "{min = 20; max = 50;}"
"min and max width of the columns";
height = helpers.defaultNullOpts.mkNullable rangeOption {
min = 4;
max = 25;
} "min and max height of the columns";
width = helpers.defaultNullOpts.mkNullable rangeOption {
min = 20;
max = 50;
} "min and max width of the columns";
spacing = helpers.defaultNullOpts.mkInt 3 "spacing between columns";
align = helpers.defaultNullOpts.mkEnumFirstDefault [
"left"