1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2024-12-14 11:57:55 +00:00
home-manager/modules/programs/yt-dlp.nix
Emily c1d8d2a3d1 treewide: adjust some DocBook for conversion
The NixOS variant of Markdown doesn't make a distinction between
`<code>` and `<literal>` or `<quote>` and... quotes, and doesn't
support `<parameter>` or `<replaceable>`. These are infrequently used
(apart from `<code>`) and don't add much, so just convert them to
simpler forms to allow the options containing them to be converted
to Markdown automatically.

A few minor syntactic adjustments were also made to make
`nix-doc-munge`'s job easier.
2023-07-17 16:49:35 +01:00

76 lines
2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.yt-dlp;
renderSettings = mapAttrsToList (name: value:
if isBool value then
if value then "--${name}" else "--no-${name}"
else
"--${name} ${toString value}");
in {
meta.maintainers = [ ];
options.programs.yt-dlp = {
enable = mkEnableOption "yt-dlp";
package = mkOption {
type = types.package;
default = pkgs.yt-dlp;
defaultText = literalExpression "pkgs.yt-dlp";
description = "Package providing the <command>yt-dlp</command> tool.";
};
settings = mkOption {
type = with types; attrsOf (oneOf [ bool int str ]);
default = { };
example = literalExpression ''
{
embed-thumbnail = true;
embed-subs = true;
sub-langs = "all";
downloader = "aria2c";
downloader-args = "aria2c:'-c -x8 -s8 -k1M'";
}
'';
description = ''
Configuration written to
<filename>$XDG_CONFIG_HOME/yt-dlp/config</filename>.
</para><para>
Options must be specified in their "long form", for
example, <literal>update = true;</literal> instead of <literal>U = true;</literal>.
Short options can be specified in the <literal>extraConfig</literal> option.
See <link xlink:href="https://github.com/yt-dlp/yt-dlp#configuration"/>
for explanation about possible values.
'';
};
extraConfig = mkOption {
type = types.lines;
default = "";
example = ''
--update
-F
'';
description = ''
Extra configuration to add to
<filename>$XDG_CONFIG_HOME/yt-dlp/config</filename>.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
xdg.configFile."yt-dlp/config" =
mkIf (cfg.settings != { } || cfg.extraConfig != "") {
text = concatStringsSep "\n"
(remove "" (renderSettings cfg.settings ++ [ cfg.extraConfig ]))
+ "\n";
};
};
}