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

lib/keymaps: refactor mkMapOptionSubmodule again

Browse source 
Allow passing in `key` and `action` as either bool or an attrset.

If `false`, the option is omitted. If `true` or an attrset, the option is included.
If an attrset is used, it will update the default `mkOption` args.
This is useful for overriding `type` or adding an `example`.
This commit is contained in:
Matt Sturgeon 2024-06-07 08:43:41 +01:00
parent c16533b3f7
commit 302262304e
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 11 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

21
lib/keymap-helpers.nix
View file

@ -60,11 +60,7 @@ rec {
# ["" "n" "v" ...]
(map ({ short, ... }: short) (attrValues modes));
mapOptionSubmodule = mkMapOptionSubmodule {
hasKey = true;
hasAction = true;
rawAction = true;
};
mapOptionSubmodule = mkMapOptionSubmodule { };
mkModeOption =
default:
@ -85,9 +81,10 @@ rec {
mkMapOptionSubmodule =
{
defaults ? { },
hasKey ? false,
hasAction ? false,
rawAction ? true,
# key and action can be true/false to enable/disable adding the option,
# or an attrset to enable the option and add/override mkOption args.
key ? true,
action ? true,
}:
# TODO remove assert once `lua` option is gone
# This is here to ensure no uses of `mkMapOptionSubmodule` set a `lua` default
@ -96,22 +93,24 @@ rec {
with types;
submodule {
options =
(optionalAttrs hasKey {
(optionalAttrs (isAttrs key || key) {
key = mkOption (
{
type = str;
description = "The key to map.";
example = "<C-m>";
}
// (optionalAttrs (isAttrs key) key)
// (optionalAttrs (defaults ? key) { default = defaults.key; })
);
})
// (optionalAttrs hasAction {
// (optionalAttrs (isAttrs action || action) {
action = mkOption (
{
type = if rawAction then nixvimTypes.maybeRaw str else str;
type = nixvimTypes.maybeRaw str;
description = "The action to execute.";
}
// (optionalAttrs (isAttrs action) action)
// (optionalAttrs (defaults ? action) { default = defaults.action; })
);
})