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

87 lines
2.1 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.navi;
yamlFormat = pkgs.formats.yaml { };
configDir = if pkgs.stdenv.isDarwin then
"Library/Application Support"
else
config.xdg.configHome;
in {
meta.maintainers = [ ];
options.programs.navi = {
enable = mkEnableOption (lib.mdDoc "Navi");
package = mkOption {
type = types.package;
default = pkgs.navi;
defaultText = literalExpression "pkgs.navi";
description = lib.mdDoc "The package to use for the navi binary.";
};
settings = mkOption {
type = yamlFormat.type;
default = { };
example = literalExpression ''
{
cheats = {
paths = [
"~/cheats/"
];
};
}
'';
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/navi/config.yaml` on Linux or
{file}`$HOME/Library/Application Support/navi/config.yaml`
on Darwin. See
<https://github.com/denisidoro/navi/blob/master/docs/config_file.md>
for more information.
'';
};
enableBashIntegration = mkEnableOption (lib.mdDoc "Bash integration") // {
default = true;
};
enableZshIntegration = mkEnableOption (lib.mdDoc "Zsh integration") // {
default = true;
};
enableFishIntegration = mkEnableOption (lib.mdDoc "Fish integration") // {
default = true;
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
programs.bash.initExtra = mkIf cfg.enableBashIntegration ''
if [[ :$SHELLOPTS: =~ :(vi|emacs): ]]; then
eval "$(${cfg.package}/bin/navi widget bash)"
fi
'';
programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
if [[ $options[zle] = on ]]; then
eval "$(${cfg.package}/bin/navi widget zsh)"
fi
'';
programs.fish.shellInit = mkIf cfg.enableFishIntegration ''
${cfg.package}/bin/navi widget fish | source
'';
home.file."${configDir}/navi/config.yaml" = mkIf (cfg.settings != { }) {
source = yamlFormat.generate "navi-config" cfg.settings;
};
};
}