plugins/mark-radar: refactor + tests (#287)

This commit is contained in:
Gaétan Lepage 2023-03-24 13:11:46 +01:00 committed by GitHub
parent cbae935d89
commit 5ae654b74d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 69 additions and 29 deletions

View file

@ -3,50 +3,73 @@
config, config,
lib, lib,
... ...
}: } @ args:
with lib; let with lib; let
cfg = config.plugins.mark-radar; cfg = config.plugins.mark-radar;
helpers = import ../helpers.nix {inherit lib;}; helpers = import ../helpers.nix {inherit lib;};
defs = import ../plugin-defs.nix {inherit pkgs;}; defs = import ../plugin-defs.nix {inherit pkgs;};
optionWarnings = import ../../lib/option-warnings.nix args;
basePluginPath = ["plugins" "mark-radar"];
in { in {
options.plugins.mark-radar = { # Those renames were done on 03-24-2023
imports = [
(optionWarnings.mkRenamedOption {
option = basePluginPath ++ ["highlight_background"];
newOption = basePluginPath ++ ["backgroundHighlight"];
})
(optionWarnings.mkRenamedOption {
option = basePluginPath ++ ["background_highlight_group"];
newOption = basePluginPath ++ ["backgroundHighlightGroup"];
})
(optionWarnings.mkRenamedOption {
option = basePluginPath ++ ["highlight_group"];
newOption = basePluginPath ++ ["highlightGroup"];
})
(optionWarnings.mkRenamedOption {
option = basePluginPath ++ ["set_default_keybinds"];
newOption = basePluginPath ++ ["setDefaultMappings"];
})
];
options.plugins.mark-radar =
helpers.extraOptionsOptions
// {
enable = mkEnableOption "mark-radar"; enable = mkEnableOption "mark-radar";
package = helpers.mkPackageOption "mark-radar" defs.mark-radar; package = helpers.mkPackageOption "mark-radar" defs.mark-radar;
highlight_background = mkOption { setDefaultMappings =
type = with types; nullOr bool; helpers.defaultNullOpts.mkBool true
default = null; "Whether to set default mappings.";
};
background_highlight_group = mkOption { highlightGroup =
type = with types; nullOr str; helpers.defaultNullOpts.mkStr "RadarMark"
default = null; "The name of the highlight group to use.";
};
highlight_group = mkOption { backgroundHighlight =
type = with types; nullOr str; helpers.defaultNullOpts.mkBool true
default = null; "Whether to highlight the background.";
};
set_default_keybinds = mkOption { backgroundHighlightGroup =
type = with types; nullOr str; helpers.defaultNullOpts.mkStr "RadarBackground"
default = null; "The name of the highlight group to use for the background.";
};
}; };
config = let config = let
opts = helpers.toLuaObject { setupOptions =
inherit (cfg) highlight_group background_highlight_group; {
set_default_mappings = cfg.set_default_keybinds; set_default_mappings = cfg.setDefaultMappings;
background_highlight = cfg.highlight_background; highlight_group = cfg.highlightGroup;
}; background_highlight = cfg.backgroundHighlight;
background_highlight_group = cfg.backgroundHighlightGroup;
}
// cfg.extraOptions;
in in
mkIf cfg.enable { mkIf cfg.enable {
extraPlugins = [cfg.package]; extraPlugins = [cfg.package];
extraConfigLua = '' extraConfigLua = ''
require("mark-radar").setup(${opts}) require("mark-radar").setup(${helpers.toLuaObject setupOptions})
''; '';
}; };
} }

View file

@ -0,0 +1,17 @@
{
empty = {
plugins.mark-radar.enable = true;
};
# All the upstream default options of mark-radar
defaults = {
plugins.mark-radar = {
enable = true;
setDefaultMappings = true;
highlightGroup = "RadarMark";
backgroundHighlight = true;
backgroundHighlightGroup = "RadarBackground";
};
};
}