home-manager/modules/programs/pet.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

107 lines
2.5 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.pet;
format = pkgs.formats.toml { };
snippetType = types.submodule {
options = {
description = mkOption {
type = types.str;
default = "";
example = "Count the number of commits in the current branch";
description = lib.mdDoc ''
Description of the snippet.
'';
};
command = mkOption {
type = types.str;
default = "";
example = "git rev-list --count HEAD";
description = lib.mdDoc ''
The command.
'';
};
output = mkOption {
type = types.str;
default = "";
example = "473";
description = lib.mdDoc ''
Example output of the command.
'';
};
tag = mkOption {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''["git" "nixpkgs"]'';
description = lib.mdDoc ''
List of tags attached to the command.
'';
};
};
};
in {
options.programs.pet = {
enable = mkEnableOption (lib.mdDoc "pet");
settings = mkOption {
type = format.type;
default = { };
description = lib.mdDoc ''
Settings written to {file}`config.toml`. See the pet
documentation for details.
'';
};
selectcmdPackage = mkOption {
type = types.package;
default = pkgs.fzf;
defaultText = literalExpression "pkgs.fzf";
description = lib.mdDoc ''
The package needed for the {var}`settings.selectcmd`.
'';
};
snippets = mkOption {
type = types.listOf snippetType;
default = [ ];
description = lib.mdDoc ''
The snippets.
'';
};
};
config = mkIf cfg.enable {
programs.pet.settings = let
defaultGeneral = {
selectcmd = mkDefault "fzf";
snippetfile = config.xdg.configHome + "/pet/snippet.toml";
};
in if versionAtLeast config.home.stateVersion "21.11" then {
General = defaultGeneral;
} else
defaultGeneral;
home.packages = [ pkgs.pet cfg.selectcmdPackage ];
xdg.configFile = {
"pet/config.toml".source = format.generate "config.toml"
(if versionAtLeast config.home.stateVersion "21.11" then
cfg.settings
else {
General = cfg.settings;
});
"pet/snippet.toml" = mkIf (cfg.snippets != [ ]) {
source = format.generate "snippet.toml" { snippets = cfg.snippets; };
};
};
};
}