mirror of
https://github.com/nix-community/home-manager
synced 2024-09-10 05:16:29 +02:00
These (and the `*MD` functions apart from `literalMD`) are now no-ops in nixpkgs and serve no purpose other than to add additional noise and potentially mislead people into thinking unmarked DocBook documentation will still be accepted. Note that if backporting changes including documentation to 23.05, the `mdDoc` calls will need to be re-added. 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 \ --strip {} + $ ./format
141 lines
3.8 KiB
Nix
141 lines
3.8 KiB
Nix
{ config, pkgs, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.programs.atuin;
|
|
|
|
tomlFormat = pkgs.formats.toml { };
|
|
|
|
in {
|
|
meta.maintainers = [ maintainers.hawkw ];
|
|
|
|
options.programs.atuin = {
|
|
enable = mkEnableOption "atuin";
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.atuin;
|
|
defaultText = literalExpression "pkgs.atuin";
|
|
description = "The package to use for atuin.";
|
|
};
|
|
|
|
enableBashIntegration = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = ''
|
|
Whether to enable Atuin's Bash integration. This will bind
|
|
`ctrl-r` to open the Atuin history.
|
|
'';
|
|
};
|
|
|
|
enableZshIntegration = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = ''
|
|
Whether to enable Atuin's Zsh integration.
|
|
|
|
If enabled, this will bind `ctrl-r` and the up-arrow
|
|
key to open the Atuin history.
|
|
'';
|
|
};
|
|
|
|
enableFishIntegration = mkOption {
|
|
default = true;
|
|
type = types.bool;
|
|
description = ''
|
|
Whether to enable Atuin's Fish integration.
|
|
|
|
If enabled, this will bind the up-arrow key to open the Atuin history.
|
|
'';
|
|
};
|
|
|
|
flags = mkOption {
|
|
default = [ ];
|
|
type = types.listOf types.str;
|
|
example = [ "--disable-up-arrow" "--disable-ctrl-r" ];
|
|
description = ''
|
|
Flags to append to the shell hook.
|
|
'';
|
|
};
|
|
|
|
settings = mkOption {
|
|
type = with types;
|
|
let
|
|
prim = oneOf [ bool int str ];
|
|
primOrPrimAttrs = either prim (attrsOf prim);
|
|
entry = either prim (listOf primOrPrimAttrs);
|
|
entryOrAttrsOf = t: either entry (attrsOf t);
|
|
entries = entryOrAttrsOf (entryOrAttrsOf entry);
|
|
in attrsOf entries // { description = "Atuin configuration"; };
|
|
default = { };
|
|
example = literalExpression ''
|
|
{
|
|
auto_sync = true;
|
|
sync_frequency = "5m";
|
|
sync_address = "https://api.atuin.sh";
|
|
search_mode = "prefix";
|
|
}
|
|
'';
|
|
description = ''
|
|
Configuration written to
|
|
{file}`$XDG_CONFIG_HOME/atuin/config.toml`.
|
|
|
|
See <https://atuin.sh/docs/config/> for the full list
|
|
of options.
|
|
'';
|
|
};
|
|
|
|
enableNushellIntegration = mkOption {
|
|
default = true;
|
|
type = types.bool;
|
|
description = ''
|
|
Whether to enable Nushell integration.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = let flagsStr = escapeShellArgs cfg.flags;
|
|
in mkIf cfg.enable {
|
|
|
|
# Always add the configured `atuin` package.
|
|
home.packages = [ cfg.package ];
|
|
|
|
# If there are user-provided settings, generate the config file.
|
|
xdg.configFile."atuin/config.toml" = mkIf (cfg.settings != { }) {
|
|
source = tomlFormat.generate "atuin-config" cfg.settings;
|
|
};
|
|
|
|
programs.bash.initExtra = mkIf cfg.enableBashIntegration ''
|
|
if [[ :$SHELLOPTS: =~ :(vi|emacs): ]]; then
|
|
source "${pkgs.bash-preexec}/share/bash/bash-preexec.sh"
|
|
eval "$(${cfg.package}/bin/atuin init bash ${flagsStr})"
|
|
fi
|
|
'';
|
|
|
|
programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
|
|
if [[ $options[zle] = on ]]; then
|
|
eval "$(${cfg.package}/bin/atuin init zsh ${flagsStr})"
|
|
fi
|
|
'';
|
|
|
|
programs.fish.interactiveShellInit = mkIf cfg.enableFishIntegration ''
|
|
${cfg.package}/bin/atuin init fish ${flagsStr} | source
|
|
'';
|
|
|
|
programs.nushell = mkIf cfg.enableNushellIntegration {
|
|
extraEnv = ''
|
|
let atuin_cache = "${config.xdg.cacheHome}/atuin"
|
|
if not ($atuin_cache | path exists) {
|
|
mkdir $atuin_cache
|
|
}
|
|
${cfg.package}/bin/atuin init nu ${flagsStr} | save --force ${config.xdg.cacheHome}/atuin/init.nu
|
|
'';
|
|
extraConfig = ''
|
|
source ${config.xdg.cacheHome}/atuin/init.nu
|
|
'';
|
|
};
|
|
};
|
|
}
|