1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-09-29 17:57:28 +02:00
home-manager/modules/programs/topgrade.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

60 lines
1.4 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.topgrade;
tomlFormat = pkgs.formats.toml { };
in {
meta.maintainers = [ hm.maintainers.msfjarvis ];
options.programs.topgrade = {
enable = mkEnableOption (lib.mdDoc "topgrade");
package = mkOption {
type = types.package;
default = pkgs.topgrade;
defaultText = literalExpression "pkgs.topgrade";
description = lib.mdDoc "The package to use for the topgrade binary.";
};
settings = mkOption {
type = tomlFormat.type;
default = { };
defaultText = literalExpression "{ }";
example = literalExpression ''
{
assume_yes = true;
disable = [
"flutter"
"node"
];
set_title = false;
cleanup = true;
commands = {
"Run garbage collection on Nix store" = "nix-collect-garbage";
};
}
'';
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/topgrade.toml`.
See <https://github.com/r-darwish/topgrade/wiki/Step-list> for the full list
of options.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
xdg.configFile."topgrade.toml" = mkIf (cfg.settings != { }) {
source = tomlFormat.generate "topgrade-config" cfg.settings;
};
};
}