301 lines
8.6 KiB
Nix
301 lines
8.6 KiB
Nix
# This module defines global configuration for the zshell.
|
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfge = config.environment;
|
|
|
|
cfg = config.programs.zsh;
|
|
|
|
zshAliases = concatStringsSep "\n" (
|
|
mapAttrsFlatten (k: v: "alias ${k}=${escapeShellArg v}")
|
|
(filterAttrs (k: v: v != null) cfg.shellAliases)
|
|
);
|
|
|
|
zshStartupNotes = ''
|
|
# Note that generated /etc/zprofile and /etc/zshrc files do a lot of
|
|
# non-standard setup to make zsh usable with no configuration by default.
|
|
#
|
|
# Which means that unless you explicitly meticulously override everything
|
|
# generated, interactions between your ~/.zshrc and these files are likely
|
|
# to be rather surprising.
|
|
#
|
|
# Note however, that you can disable loading of the generated /etc/zprofile
|
|
# and /etc/zshrc (you can't disable loading of /etc/zshenv, but it is
|
|
# designed to not set anything surprising) by setting `no_global_rcs` option
|
|
# in ~/.zshenv:
|
|
#
|
|
# echo setopt no_global_rcs >> ~/.zshenv
|
|
#
|
|
# See "STARTUP/SHUTDOWN FILES" section of zsh(1) for more info.
|
|
'';
|
|
|
|
in
|
|
|
|
{
|
|
|
|
options = {
|
|
|
|
programs.zsh = {
|
|
|
|
enable = mkOption {
|
|
default = false;
|
|
description = ''
|
|
Whether to configure zsh as an interactive shell. To enable zsh for
|
|
a particular user, use the <option>users.users.<name?>.shell</option>
|
|
option for that user. To enable zsh system-wide use the
|
|
<option>users.defaultUserShell</option> option.
|
|
'';
|
|
type = types.bool;
|
|
};
|
|
|
|
shellAliases = mkOption {
|
|
default = { };
|
|
description = ''
|
|
Set of aliases for zsh shell, which overrides <option>environment.shellAliases</option>.
|
|
See <option>environment.shellAliases</option> for an option format description.
|
|
'';
|
|
type = with types; attrsOf (nullOr (either str path));
|
|
};
|
|
|
|
shellInit = mkOption {
|
|
default = "";
|
|
description = ''
|
|
Shell script code called during zsh shell initialisation.
|
|
'';
|
|
type = types.lines;
|
|
};
|
|
|
|
loginShellInit = mkOption {
|
|
default = "";
|
|
description = ''
|
|
Shell script code called during zsh login shell initialisation.
|
|
'';
|
|
type = types.lines;
|
|
};
|
|
|
|
interactiveShellInit = mkOption {
|
|
default = "";
|
|
description = ''
|
|
Shell script code called during interactive zsh shell initialisation.
|
|
'';
|
|
type = types.lines;
|
|
};
|
|
|
|
promptInit = mkOption {
|
|
default = ''
|
|
# Note that to manually override this in ~/.zshrc you should run `prompt off`
|
|
# before setting your PS1 and etc. Otherwise this will likely to interact with
|
|
# your ~/.zshrc configuration in unexpected ways as the default prompt sets
|
|
# a lot of different prompt variables.
|
|
autoload -U promptinit && promptinit && prompt suse && setopt prompt_sp
|
|
'';
|
|
description = ''
|
|
Shell script code used to initialise the zsh prompt.
|
|
'';
|
|
type = types.lines;
|
|
};
|
|
|
|
histSize = mkOption {
|
|
default = 2000;
|
|
description = ''
|
|
Change history size.
|
|
'';
|
|
type = types.int;
|
|
};
|
|
|
|
histFile = mkOption {
|
|
default = "$HOME/.zsh_history";
|
|
description = ''
|
|
Change history file.
|
|
'';
|
|
type = types.str;
|
|
};
|
|
|
|
setOptions = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [
|
|
"HIST_IGNORE_DUPS"
|
|
"SHARE_HISTORY"
|
|
"HIST_FCNTL_LOCK"
|
|
];
|
|
example = [ "EXTENDED_HISTORY" "RM_STAR_WAIT" ];
|
|
description = ''
|
|
Configure zsh options. See
|
|
<citerefentry><refentrytitle>zshoptions</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
'';
|
|
};
|
|
|
|
enableCompletion = mkOption {
|
|
default = true;
|
|
description = ''
|
|
Enable zsh completion for all interactive zsh shells.
|
|
'';
|
|
type = types.bool;
|
|
};
|
|
|
|
enableBashCompletion = mkOption {
|
|
default = false;
|
|
description = ''
|
|
Enable compatibility with bash's programmable completion system.
|
|
'';
|
|
type = types.bool;
|
|
};
|
|
|
|
enableGlobalCompInit = mkOption {
|
|
default = cfg.enableCompletion;
|
|
description = ''
|
|
Enable execution of compinit call for all interactive zsh shells.
|
|
|
|
This option can be disabled if the user wants to extend its
|
|
<literal>fpath</literal> and a custom <literal>compinit</literal>
|
|
call in the local config is required.
|
|
'';
|
|
type = types.bool;
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
programs.zsh.shellAliases = mapAttrs (name: mkDefault) cfge.shellAliases;
|
|
|
|
environment.etc.zshenv.text =
|
|
''
|
|
# /etc/zshenv: DO NOT EDIT -- this file has been generated automatically.
|
|
# This file is read for all shells.
|
|
|
|
# Only execute this file once per shell.
|
|
if [ -n "$__ETC_ZSHENV_SOURCED" ]; then return; fi
|
|
__ETC_ZSHENV_SOURCED=1
|
|
|
|
if [ -z "$__NIXOS_SET_ENVIRONMENT_DONE" ]; then
|
|
. ${config.system.build.setEnvironment}
|
|
fi
|
|
|
|
HELPDIR="${pkgs.zsh}/share/zsh/$ZSH_VERSION/help"
|
|
|
|
# Tell zsh how to find installed completions.
|
|
for p in ''${(z)NIX_PROFILES}; do
|
|
fpath+=($p/share/zsh/site-functions $p/share/zsh/$ZSH_VERSION/functions $p/share/zsh/vendor-completions)
|
|
done
|
|
|
|
# Setup custom shell init stuff.
|
|
${cfge.shellInit}
|
|
|
|
${cfg.shellInit}
|
|
|
|
# Read system-wide modifications.
|
|
if test -f /etc/zshenv.local; then
|
|
. /etc/zshenv.local
|
|
fi
|
|
'';
|
|
|
|
environment.etc.zprofile.text =
|
|
''
|
|
# /etc/zprofile: DO NOT EDIT -- this file has been generated automatically.
|
|
# This file is read for login shells.
|
|
#
|
|
${zshStartupNotes}
|
|
|
|
# Only execute this file once per shell.
|
|
if [ -n "$__ETC_ZPROFILE_SOURCED" ]; then return; fi
|
|
__ETC_ZPROFILE_SOURCED=1
|
|
|
|
# Setup custom login shell init stuff.
|
|
${cfge.loginShellInit}
|
|
|
|
${cfg.loginShellInit}
|
|
|
|
# Read system-wide modifications.
|
|
if test -f /etc/zprofile.local; then
|
|
. /etc/zprofile.local
|
|
fi
|
|
'';
|
|
|
|
environment.etc.zshrc.text =
|
|
''
|
|
# /etc/zshrc: DO NOT EDIT -- this file has been generated automatically.
|
|
# This file is read for interactive shells.
|
|
#
|
|
${zshStartupNotes}
|
|
|
|
# Only execute this file once per shell.
|
|
if [ -n "$__ETC_ZSHRC_SOURCED" -o -n "$NOSYSZSHRC" ]; then return; fi
|
|
__ETC_ZSHRC_SOURCED=1
|
|
|
|
${optionalString (cfg.setOptions != []) ''
|
|
# Set zsh options.
|
|
setopt ${concatStringsSep " " cfg.setOptions}
|
|
''}
|
|
|
|
# Setup command line history.
|
|
# Don't export these, otherwise other shells (bash) will try to use same HISTFILE.
|
|
SAVEHIST=${toString cfg.histSize}
|
|
HISTSIZE=${toString cfg.histSize}
|
|
HISTFILE=${cfg.histFile}
|
|
|
|
# Configure sane keyboard defaults.
|
|
. /etc/zinputrc
|
|
|
|
${optionalString cfg.enableGlobalCompInit ''
|
|
# Enable autocompletion.
|
|
autoload -U compinit && compinit
|
|
''}
|
|
|
|
${optionalString cfg.enableBashCompletion ''
|
|
# Enable compatibility with bash's completion system.
|
|
autoload -U bashcompinit && bashcompinit
|
|
''}
|
|
|
|
# Setup custom interactive shell init stuff.
|
|
${cfge.interactiveShellInit}
|
|
|
|
${cfg.interactiveShellInit}
|
|
|
|
# Setup aliases.
|
|
${zshAliases}
|
|
|
|
# Setup prompt.
|
|
${cfg.promptInit}
|
|
|
|
# Disable some features to support TRAMP.
|
|
if [ "$TERM" = dumb ]; then
|
|
unsetopt zle prompt_cr prompt_subst
|
|
unset RPS1 RPROMPT
|
|
PS1='$ '
|
|
PROMPT='$ '
|
|
fi
|
|
|
|
# Read system-wide modifications.
|
|
if test -f /etc/zshrc.local; then
|
|
. /etc/zshrc.local
|
|
fi
|
|
'';
|
|
|
|
# Bug in nix flakes:
|
|
# If we use `.source` here the path is garbage collected also we point to it with a symlink
|
|
# see https://github.com/NixOS/nixpkgs/issues/132732
|
|
environment.etc.zinputrc.text = builtins.readFile ./zinputrc;
|
|
|
|
environment.systemPackages = [ pkgs.zsh ]
|
|
++ optional cfg.enableCompletion pkgs.nix-zsh-completions;
|
|
|
|
environment.pathsToLink = optional cfg.enableCompletion "/share/zsh";
|
|
|
|
#users.defaultUserShell = mkDefault "/run/current-system/sw/bin/zsh";
|
|
|
|
environment.shells =
|
|
[
|
|
"/run/current-system/sw/bin/zsh"
|
|
"${pkgs.zsh}/bin/zsh"
|
|
];
|
|
|
|
};
|
|
|
|
}
|