home-manager/modules/programs/tiny.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

66 lines
1.7 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.tiny;
format = pkgs.formats.yaml { };
configDir = if pkgs.stdenv.isDarwin then
"Library/Application Support/tiny"
else
"${config.xdg.configHome}/tiny";
in {
meta.maintainers = [ hm.maintainers.kmaasrud ];
options = {
programs.tiny = {
enable =
mkEnableOption (lib.mdDoc "tiny, a TUI IRC client written in Rust");
package = mkOption {
type = types.package;
default = pkgs.tiny;
defaultText = literalExpression "pkgs.tiny";
description = lib.mdDoc "The {command}`tiny` package to install.";
};
settings = mkOption {
type = format.type;
default = { };
defaultText = literalExpression "{ }";
example = literalExpression ''
{
servers = [
{
addr = "irc.libera.chat";
port = 6697;
tls = true;
realname = "John Doe";
nicks = [ "tinyuser" ];
}
];
defaults = {
nicks = [ "tinyuser" ];
realname = "John Doe";
join = [];
tls = true;
};
};
'';
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/tiny/config.yml`. See
<https://github.com/osa1/tiny/blob/master/crates/tiny/config.yml>
for the default configuration.
'';
};
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
home.file."${configDir}/config.yml" = mkIf (cfg.settings != { }) {
source = format.generate "tiny-config" cfg.settings;
};
};
}