nixpkgs/pkgs/shells/zsh/default.nix
Lin Jian 8e2e741ab5
zsh: set environment variables in zshenv instead of zprofile
This patch fixes two issues:

1. The file in which environment variables are set is inconsistent.
  - This file sets them in zprofile when programs.zsh.enable is not
  set.
  - Zsh module sets them in zshenv when programs.zsh.enable is set.

2. Setting environment variables in zprofile overrides what users set
in .zshenv.  See these[1] home-manager[2] issues[3].

/etc/profile is also changed to /etc/set-environment. Here is a
comparison:

Using /etc/profile:
- Pros
  - config.environment.shellInit is sourced in all zsh
- Cons
  - config.environment.loginShellInit is also sourced in non-login zsh
  - config.programs.bash.shellInit is also sourced in all zsh
  - config.programs.bash.loginShellInit is also sourced in all zsh

Using /etc/set-environment:
- Pros
  - config.programs.bash.shellInit is not sourced in any zsh
  - config.programs.bash.loginShellInit is not sourced in any zsh
- Cons
  - config.environment.shellInit is not sourced in any zsh
  - config.environment.loginShellInit is not sourced in any zsh

[1]: https://github.com/nix-community/home-manager/issues/2751#issuecomment-1048682643
[2]: https://github.com/nix-community/home-manager/issues/2991
[3]: https://github.com/nix-community/home-manager/issues/3681#issuecomment-1436054233
2023-03-13 17:25:04 +08:00

124 lines
3.3 KiB
Nix

{ lib
, stdenv
, fetchurl
, fetchpatch
, autoreconfHook
, yodl
, perl
, groff
, util-linux
, texinfo
, ncurses
, pcre
, buildPackages }:
let
version = "5.9";
in
stdenv.mkDerivation {
pname = "zsh";
inherit version;
outputs = [ "out" "doc" "info" "man" ];
src = fetchurl {
url = "mirror://sourceforge/zsh/zsh-${version}.tar.xz";
sha256 = "sha256-m40ezt1bXoH78ZGOh2dSp92UjgXBoNuhCrhjhC1FrNU=";
};
patches = [
# fix location of timezone data for TZ= completion
./tz_completion.patch
];
strictDeps = true;
nativeBuildInputs = [ autoreconfHook perl groff texinfo pcre]
++ lib.optionals stdenv.isLinux [ util-linux yodl ];
buildInputs = [ ncurses pcre ];
configureFlags = [
"--enable-maildir-support"
"--enable-multibyte"
"--with-tcsetpgrp"
"--enable-pcre"
"--enable-zshenv=${placeholder "out"}/etc/zshenv"
"--disable-site-fndir"
] ++ lib.optionals (stdenv.hostPlatform != stdenv.buildPlatform && !stdenv.hostPlatform.isStatic) [
# Also see: https://github.com/buildroot/buildroot/commit/2f32e668aa880c2d4a2cce6c789b7ca7ed6221ba
"zsh_cv_shared_environ=yes"
"zsh_cv_shared_tgetent=yes"
"zsh_cv_shared_tigetstr=yes"
"zsh_cv_sys_dynamic_clash_ok=yes"
"zsh_cv_sys_dynamic_rtld_global=yes"
"zsh_cv_sys_dynamic_execsyms=yes"
"zsh_cv_sys_dynamic_strip_exe=yes"
"zsh_cv_sys_dynamic_strip_lib=yes"
];
# the zsh/zpty module is not available on hydra
# so skip groups Y Z
checkFlags = map (T: "TESTNUM=${T}") (lib.stringToCharacters "ABCDEVW");
# XXX: think/discuss about this, also with respect to nixos vs nix-on-X
postInstall = ''
make install.info install.html
mkdir -p $out/etc/
cat > $out/etc/zshenv <<EOF
if test -e /etc/NIXOS; then
if test -r /etc/zshenv; then
. /etc/zshenv
else
emulate bash
alias shopt=false
if [ -z "$__NIXOS_SET_ENVIRONMENT_DONE" ]; then
. /etc/set-environment
fi
unalias shopt
emulate zsh
fi
if test -r /etc/zshenv.local; then
. /etc/zshenv.local
fi
else
# on non-nixos we just source the global /etc/zshenv as if we did
# not use the configure flag
if test -r /etc/zshenv; then
. /etc/zshenv
fi
fi
EOF
${if stdenv.hostPlatform == stdenv.buildPlatform then ''
$out/bin/zsh -c "zcompile $out/etc/zshenv"
'' else ''
${lib.getBin buildPackages.zsh}/bin/zsh -c "zcompile $out/etc/zshenv"
''}
mv $out/etc/zshenv $out/etc/zshenv_zwc_is_used
rm $out/bin/zsh-${version}
mkdir -p $out/share/doc/
mv $out/share/zsh/htmldoc $out/share/doc/zsh-$version
'';
# XXX: patch zsh to take zwc if newer _or equal_
meta = {
description = "The Z shell";
longDescription = ''
Zsh is a UNIX command interpreter (shell) usable as an interactive login
shell and as a shell script command processor. Of the standard shells,
zsh most closely resembles ksh but includes many enhancements. Zsh has
command line editing, builtin spelling correction, programmable command
completion, shell functions (with autoloading), a history mechanism, and
a host of other features.
'';
license = "MIT-like";
homepage = "https://www.zsh.org/";
maintainers = with lib.maintainers; [ pSub artturin ];
platforms = lib.platforms.unix;
};
passthru = {
shellPath = "/bin/zsh";
};
}