Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fish: expose session variables package #6291

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/manual/faq/session-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@ way. In Bash and Z shell this can be done by adding
to your `.profile` and `.zshrc` files, respectively. The
`hm-session-vars.sh` file should work in most Bourne-like shells. For
fish shell, it is possible to source it using [the foreign-env
plugin](https://github.com/oh-my-fish/plugin-foreign-env)
plugin](https://github.com/oh-my-fish/plugin-foreign-env) or using the builtin
[babelfish](https://github.com/bouk/babelfish)-translated variables:

``` bash
fenv source "$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh" > /dev/null
# or
source "$HOME/.nix-profile/etc/profile.d/hm-session-vars.fish"
```
28 changes: 22 additions & 6 deletions modules/programs/fish.nix
Original file line number Diff line number Diff line change
Expand Up @@ -220,13 +220,16 @@ let
passAsFile = [ "text" ];
} "env HOME=$(mktemp -d) fish_indent < $textPath > $out";

profileDir = "/etc/profile.d";
translatedSessionVarsFile = "hm-session-vars.fish";
translatedSessionVariables =
pkgs.runCommandLocal "hm-session-vars.fish" { } ''
pkgs.runCommandLocal translatedSessionVarsFile { } ''
mkdir -p $out/${profileDir}
(echo "function setup_hm_session_vars;"
${pkgs.buildPackages.babelfish}/bin/babelfish \
<${config.home.sessionVariablesPackage}/etc/profile.d/hm-session-vars.sh
<${config.home.sessionVariablesPackage}/etc/profile.d/hm-session-vars.sh
echo "end"
echo "setup_hm_session_vars") > $out
echo "setup_hm_session_vars") > $out/${profileDir}/${translatedSessionVarsFile}
'';

in {
Expand Down Expand Up @@ -393,11 +396,24 @@ in {
<https://fishshell.com/docs/current/cmds/function.html>.
'';
};

# TODO: maybe this makes more sense as `programs.fish.sessionVariablesPackage`?
# if `programs.fish.sessionVariables` were added, would that need its own
# separate package, or would they just go in config.fish directly?
home.fishSessionVariablesPackage = mkOption {
type = types.package;
internal = true;
description = ''
The package containing the translated {file}`hm-session-vars.fish` file.
'';
};
};

config = mkIf cfg.enable (mkMerge [
{ home.packages = [ cfg.package ]; }

{
home.fishSessionVariablesPackage = translatedSessionVariables;
home.packages = [ cfg.package config.home.fishSessionVariablesPackage ];
}
(mkIf cfg.generateCompletions {
# Support completion for `man` by building a cache for `apropos`.
programs.man.generateCaches = mkDefault true;
Expand Down Expand Up @@ -473,7 +489,7 @@ in {
set -q __fish_home_manager_config_sourced; and exit
set -g __fish_home_manager_config_sourced 1

source ${translatedSessionVariables}
source ${config.home.fishSessionVariablesPackage}/${profileDir}/${translatedSessionVarsFile}

${cfg.shellInit}

Expand Down
1 change: 1 addition & 0 deletions tests/modules/programs/fish/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@
fish-functions = ./functions.nix;
fish-no-functions = ./no-functions.nix;
fish-plugins = ./plugins.nix;
fish-session-variables = ./session-variables.nix;
}
26 changes: 26 additions & 0 deletions tests/modules/programs/fish/session-variables.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{ config, lib, pkgs, ... }:

with lib;

{
config = {
home.sessionVariables = {
V1 = "v1";
V2 = "v2-${config.home.sessionVariables.V1}";
};

programs.fish = {
enable = true;

# TODO: should there be an equivalent sessionVariables here like bash + zsh?
};

nmt.script = ''
assertFileExists home-path/etc/profile.d/hm-session-vars.fish
assertFileRegex home-path/etc/profile.d/hm-session-vars.fish \
"set -gx V1 'v1'"
assertFileRegex home-path/etc/profile.d/hm-session-vars.fish \
"set -gx V1 'v1'"
'';
};
}
Loading