111b158a98
Before 19.03, programs.beets.enable implicitly followed whether programs.beets.settings was non-empty. That compatibility branch was still active for older state versions, but it was silent. Route the default through the shared state-version helper so legacy users get a consistent deprecation warning before the implicit enablement is cleaned up. Add focused tests for the legacy and current default branches alongside the existing beets coverage. Signed-off-by: Austin Horstman <khaneliman12@gmail.com>
129 lines
3.3 KiB
Nix
129 lines
3.3 KiB
Nix
{
|
||
config,
|
||
lib,
|
||
pkgs,
|
||
...
|
||
}:
|
||
let
|
||
inherit (lib)
|
||
literalExpression
|
||
mkIf
|
||
mkOption
|
||
types
|
||
;
|
||
|
||
cfg = config.programs.beets;
|
||
|
||
yamlFormat = pkgs.formats.yaml { };
|
||
|
||
in
|
||
{
|
||
meta.maintainers = with lib.maintainers; [
|
||
rycee
|
||
Scrumplex
|
||
];
|
||
|
||
options = {
|
||
programs.beets = {
|
||
enable = mkOption {
|
||
type = types.bool;
|
||
inherit
|
||
(lib.hm.deprecations.mkStateVersionOptionDefault {
|
||
inherit (config.home) stateVersion;
|
||
since = "19.03";
|
||
optionPath = [
|
||
"programs"
|
||
"beets"
|
||
"enable"
|
||
];
|
||
legacy = {
|
||
value = cfg.settings != { };
|
||
text = "config.programs.beets.settings != { }";
|
||
};
|
||
current.value = false;
|
||
})
|
||
default
|
||
defaultText
|
||
;
|
||
description = ''
|
||
Whether to enable the beets music library manager. This
|
||
defaults to `false` for state
|
||
version ≥ 19.03. For earlier versions beets is enabled if
|
||
{option}`programs.beets.settings` is non-empty.
|
||
'';
|
||
};
|
||
|
||
package = lib.mkPackageOption pkgs "beets" {
|
||
example = "(pkgs.beets.override { pluginOverrides = { beatport.enable = false; }; })";
|
||
extraDescription = ''
|
||
Can be used to specify extensions.
|
||
'';
|
||
};
|
||
|
||
settings = mkOption {
|
||
type = yamlFormat.type;
|
||
default = { };
|
||
description = ''
|
||
Configuration written to
|
||
{file}`$XDG_CONFIG_HOME/beets/config.yaml`
|
||
'';
|
||
};
|
||
|
||
mpdIntegration = {
|
||
enableStats = lib.mkEnableOption "mpdstats plugin and service";
|
||
|
||
enableUpdate = lib.mkEnableOption "mpdupdate plugin";
|
||
|
||
host = mkOption {
|
||
type = types.str;
|
||
default = "localhost";
|
||
example = "10.0.0.42";
|
||
description = "The host that mpdstats will connect to.";
|
||
};
|
||
|
||
port = mkOption {
|
||
type = types.port;
|
||
default = config.services.mpd.network.port;
|
||
defaultText = literalExpression "config.services.mpd.network.port";
|
||
example = 6601;
|
||
description = "The port that mpdstats will connect to.";
|
||
};
|
||
};
|
||
};
|
||
};
|
||
|
||
config = lib.mkMerge [
|
||
(mkIf cfg.enable {
|
||
home.packages = [ cfg.package ];
|
||
|
||
xdg.configFile."beets/config.yaml".source = yamlFormat.generate "beets-config" cfg.settings;
|
||
})
|
||
|
||
(mkIf (cfg.mpdIntegration.enableStats || cfg.mpdIntegration.enableUpdate) {
|
||
programs.beets.settings.mpd = {
|
||
host = cfg.mpdIntegration.host;
|
||
port = cfg.mpdIntegration.port;
|
||
};
|
||
})
|
||
|
||
(mkIf cfg.mpdIntegration.enableStats {
|
||
programs.beets.settings.plugins = [ "mpdstats" ];
|
||
})
|
||
|
||
(mkIf cfg.mpdIntegration.enableUpdate {
|
||
programs.beets.settings.plugins = [ "mpdupdate" ];
|
||
})
|
||
|
||
(mkIf (cfg.enable && cfg.mpdIntegration.enableStats) {
|
||
systemd.user.services."beets-mpdstats" = {
|
||
Unit = {
|
||
Description = "Beets MPDStats daemon";
|
||
After = lib.optional config.services.mpd.enable "mpd.service";
|
||
Requires = lib.optional config.services.mpd.enable "mpd.service";
|
||
};
|
||
Service.ExecStart = "${cfg.package}/bin/beet mpdstats";
|
||
Install.WantedBy = [ "default.target" ];
|
||
};
|
||
})
|
||
];
|
||
}
|