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

89 lines
2.5 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.joshuto;
tomlFormat = pkgs.formats.toml { };
in {
meta.maintainers = [ hm.maintainers.rasmus-kirk ];
options.programs.joshuto = {
enable = mkEnableOption (lib.mdDoc "joshuto file manager");
package = mkOption {
type = types.package;
default = pkgs.joshuto;
defaultText = literalExpression "pkgs.joshuto";
description = lib.mdDoc "The package to use for joshuto.";
};
settings = mkOption {
type = tomlFormat.type;
default = { };
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/joshuto/joshuto.toml`.
See <https://github.com/kamiyaa/joshuto/blob/main/docs/configuration/joshuto.toml.md>
for the full list of options.
'';
};
keymap = mkOption {
type = tomlFormat.type;
default = { };
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/joshuto/keymap.toml`.
See <https://github.com/kamiyaa/joshuto/blob/main/docs/configuration/keymap.toml.md>
for the full list of options. Note that this option will overwrite any existing keybinds.
'';
};
mimetype = mkOption {
type = tomlFormat.type;
default = { };
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/joshuto/mimetype.toml`.
See <https://github.com/kamiyaa/joshuto/blob/main/docs/configuration/mimetype.toml.md>
for the full list of options
'';
};
theme = mkOption {
type = tomlFormat.type;
default = { };
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/joshuto/theme.toml`.
See <https://github.com/kamiyaa/joshuto/blob/main/docs/configuration/theme.toml.md>
for the full list of options
'';
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
xdg.configFile = {
"joshuto/joshuto.toml" = mkIf (cfg.settings != { }) {
source = tomlFormat.generate "joshuto-settings" cfg.settings;
};
"joshuto/keymap.toml" = mkIf (cfg.keymap != { }) {
source = tomlFormat.generate "joshuto-keymap" cfg.keymap;
};
"joshuto/mimetype.toml" = mkIf (cfg.mimetype != { }) {
source = tomlFormat.generate "joshuto-mimetype" cfg.mimetype;
};
"joshuto/theme.toml" = mkIf (cfg.theme != { }) {
source = tomlFormat.generate "joshuto-theme" cfg.theme;
};
};
};
}