mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-30 09:31:01 +00:00
bd40c92c2c
In the last year `programs.oh-my-zsh` gained more complexity and since the introduction of features like `customPkgs` which builds a `ZSH_CUSTOM` path from a sequence of derivation a documentation may be fairly helpful to make the knowledge how to use the module and how to package new ZSH plugins visible. See https://github.com/NixOS/nixpkgs/pull/43282#issuecomment-410770432
139 lines
3.4 KiB
Nix
139 lines
3.4 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.programs.zsh.ohMyZsh;
|
|
|
|
mkLinkFarmEntry = name: dir:
|
|
let
|
|
env = pkgs.buildEnv {
|
|
name = "zsh-${name}-env";
|
|
paths = cfg.customPkgs;
|
|
pathsToLink = "/share/zsh/${dir}";
|
|
};
|
|
in
|
|
{ inherit name; path = "${env}/share/zsh/${dir}"; };
|
|
|
|
mkLinkFarmEntry' = name: mkLinkFarmEntry name name;
|
|
|
|
custom =
|
|
if cfg.custom != null then cfg.custom
|
|
else if length cfg.customPkgs == 0 then null
|
|
else pkgs.linkFarm "oh-my-zsh-custom" [
|
|
(mkLinkFarmEntry' "themes")
|
|
(mkLinkFarmEntry "completions" "site-functions")
|
|
(mkLinkFarmEntry' "plugins")
|
|
];
|
|
|
|
in
|
|
{
|
|
options = {
|
|
programs.zsh.ohMyZsh = {
|
|
enable = mkOption {
|
|
default = false;
|
|
description = ''
|
|
Enable oh-my-zsh.
|
|
'';
|
|
};
|
|
|
|
package = mkOption {
|
|
default = pkgs.oh-my-zsh;
|
|
defaultText = "pkgs.oh-my-zsh";
|
|
description = ''
|
|
Package to install for `oh-my-zsh` usage.
|
|
'';
|
|
|
|
type = types.package;
|
|
};
|
|
|
|
plugins = mkOption {
|
|
default = [];
|
|
type = types.listOf(types.str);
|
|
description = ''
|
|
List of oh-my-zsh plugins
|
|
'';
|
|
};
|
|
|
|
custom = mkOption {
|
|
default = null;
|
|
type = with types; nullOr str;
|
|
description = ''
|
|
Path to a custom oh-my-zsh package to override config of oh-my-zsh.
|
|
(Can't be used along with `customPkgs`).
|
|
'';
|
|
};
|
|
|
|
customPkgs = mkOption {
|
|
default = [];
|
|
type = types.listOf types.package;
|
|
description = ''
|
|
List of custom packages that should be loaded into `oh-my-zsh`.
|
|
'';
|
|
};
|
|
|
|
theme = mkOption {
|
|
default = "";
|
|
type = types.str;
|
|
description = ''
|
|
Name of the theme to be used by oh-my-zsh.
|
|
'';
|
|
};
|
|
|
|
cacheDir = mkOption {
|
|
default = "$HOME/.cache/oh-my-zsh";
|
|
type = types.str;
|
|
description = ''
|
|
Cache directory to be used by `oh-my-zsh`.
|
|
Without this option it would default to the read-only nix store.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
# Prevent zsh from overwriting oh-my-zsh's prompt
|
|
programs.zsh.promptInit = mkDefault "";
|
|
|
|
environment.systemPackages = [ cfg.package ];
|
|
|
|
programs.zsh.interactiveShellInit = ''
|
|
# oh-my-zsh configuration generated by NixOS
|
|
export ZSH=${cfg.package}/share/oh-my-zsh
|
|
|
|
${optionalString (length(cfg.plugins) > 0)
|
|
"plugins=(${concatStringsSep " " cfg.plugins})"
|
|
}
|
|
|
|
${optionalString (custom != null)
|
|
"ZSH_CUSTOM=\"${custom}\""
|
|
}
|
|
|
|
${optionalString (stringLength(cfg.theme) > 0)
|
|
"ZSH_THEME=\"${cfg.theme}\""
|
|
}
|
|
|
|
${optionalString (cfg.cacheDir != null) ''
|
|
if [[ ! -d "${cfg.cacheDir}" ]]; then
|
|
mkdir -p "${cfg.cacheDir}"
|
|
fi
|
|
ZSH_CACHE_DIR=${cfg.cacheDir}
|
|
''}
|
|
|
|
source $ZSH/oh-my-zsh.sh
|
|
'';
|
|
|
|
assertions = [
|
|
{
|
|
assertion = cfg.custom != null -> cfg.customPkgs == [];
|
|
message = "If `cfg.custom` is set for `ZSH_CUSTOM`, `customPkgs` can't be used!";
|
|
}
|
|
];
|
|
|
|
};
|
|
|
|
meta.doc = ./oh-my-zsh.xml;
|
|
}
|