nixpkgs/nixos/modules/programs/starship.nix

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

101 lines
3.2 KiB
Nix
Raw Normal View History

2021-12-23 22:22:39 +00:00
{ config, lib, pkgs, ... }:
let
cfg = config.programs.starship;
settingsFormat = pkgs.formats.toml { };
2023-11-14 12:31:30 +00:00
userSettingsFile = settingsFormat.generate "starship.toml" cfg.settings;
settingsFile = if cfg.presets == [] then userSettingsFile else pkgs.runCommand "starship.toml"
{
nativeBuildInputs = [ pkgs.yq ];
} ''
tomlq -s -t 'reduce .[] as $item ({}; . * $item)' \
2024-03-19 12:59:01 +00:00
${lib.concatStringsSep " " (map (f: "${cfg.package}/share/starship/presets/${f}.toml") cfg.presets)} \
2023-11-14 12:31:30 +00:00
${userSettingsFile} \
> $out
'';
2021-12-23 22:22:39 +00:00
initOption =
if cfg.interactiveOnly then
"promptInit"
else
"shellInit";
in
{
2021-12-23 22:22:39 +00:00
options.programs.starship = {
2024-03-19 13:01:25 +00:00
enable = lib.mkEnableOption "the Starship shell prompt";
2021-12-23 22:22:39 +00:00
2024-03-19 12:59:01 +00:00
package = lib.mkPackageOption pkgs "starship" { };
2024-03-19 13:01:25 +00:00
interactiveOnly = lib.mkEnableOption ''
starship only when the shell is interactive.
Some plugins require this to be set to false to function correctly
'' // { default = true; };
2023-11-14 12:31:30 +00:00
presets = lib.mkOption {
default = [ ];
example = [ "nerd-font-symbols" ];
type = with lib.types; listOf str;
2024-03-19 13:01:25 +00:00
description = ''
2023-11-14 12:31:30 +00:00
Presets files to be merged with settings in order.
'';
};
settings = lib.mkOption {
2021-12-23 22:22:39 +00:00
inherit (settingsFormat) type;
default = { };
2024-03-19 13:01:25 +00:00
description = ''
Configuration included in `starship.toml`.
2021-12-23 22:22:39 +00:00
See https://starship.rs/config/#prompt for documentation.
'';
};
};
2023-11-14 12:31:30 +00:00
config = lib.mkIf cfg.enable {
programs.bash.${initOption} = ''
if [[ $TERM != "dumb" ]]; then
# don't set STARSHIP_CONFIG automatically if there's a user-specified
# config file. starship appears to use a hardcoded config location
# rather than one inside an XDG folder:
# https://github.com/starship/starship/blob/686bda1706e5b409129e6694639477a0f8a3f01b/src/configure.rs#L651
if [[ ! -f "$HOME/.config/starship.toml" ]]; then
export STARSHIP_CONFIG=${settingsFile}
fi
2024-03-19 12:59:01 +00:00
eval "$(${cfg.package}/bin/starship init bash)"
2021-12-23 22:22:39 +00:00
fi
'';
programs.fish.${initOption} = ''
if test "$TERM" != "dumb"
# don't set STARSHIP_CONFIG automatically if there's a user-specified
# config file. starship appears to use a hardcoded config location
# rather than one inside an XDG folder:
# https://github.com/starship/starship/blob/686bda1706e5b409129e6694639477a0f8a3f01b/src/configure.rs#L651
if not test -f "$HOME/.config/starship.toml";
set -x STARSHIP_CONFIG ${settingsFile}
end
2024-03-19 12:59:01 +00:00
eval (${cfg.package}/bin/starship init fish)
2021-12-23 22:22:39 +00:00
end
'';
programs.zsh.${initOption} = ''
if [[ $TERM != "dumb" ]]; then
# don't set STARSHIP_CONFIG automatically if there's a user-specified
# config file. starship appears to use a hardcoded config location
# rather than one inside an XDG folder:
# https://github.com/starship/starship/blob/686bda1706e5b409129e6694639477a0f8a3f01b/src/configure.rs#L651
if [[ ! -f "$HOME/.config/starship.toml" ]]; then
export STARSHIP_CONFIG=${settingsFile}
fi
2024-03-19 12:59:01 +00:00
eval "$(${cfg.package}/bin/starship init zsh)"
2021-12-23 22:22:39 +00:00
fi
'';
};
meta.maintainers = pkgs.starship.meta.maintainers;
}