2018-08-07 14:38:20 +01:00
|
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
|
|
version="5.0"
|
|
|
|
xml:id="module-programs-zsh-ohmyzsh">
|
2018-09-30 01:51:11 +01:00
|
|
|
<title>Oh my ZSH</title>
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
<literal><link xlink:href="https://ohmyz.sh/">oh-my-zsh</link></literal> is a
|
|
|
|
framework to manage your <link xlink:href="https://www.zsh.org/">ZSH</link>
|
|
|
|
configuration including completion scripts for several CLI tools or custom
|
|
|
|
prompt themes.
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
<section xml:id="module-programs-oh-my-zsh-usage">
|
|
|
|
<title>Basic usage</title>
|
|
|
|
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
The module uses the <literal>oh-my-zsh</literal> package with all available
|
|
|
|
features. The initial setup using Nix expressions is fairly similar to the
|
|
|
|
configuration format of <literal>oh-my-zsh</literal>.
|
2018-08-07 14:38:20 +01:00
|
|
|
<programlisting>
|
|
|
|
{
|
2018-12-17 18:11:40 +00:00
|
|
|
programs.zsh.ohMyZsh = {
|
2018-08-07 14:38:20 +01:00
|
|
|
enable = true;
|
|
|
|
plugins = [ "git" "python" "man" ];
|
|
|
|
theme = "agnoster";
|
|
|
|
};
|
|
|
|
}
|
|
|
|
</programlisting>
|
2019-09-19 18:17:30 +01:00
|
|
|
For a detailed explanation of these arguments please refer to the
|
|
|
|
<link xlink:href="https://github.com/robbyrussell/oh-my-zsh/wiki"><literal>oh-my-zsh</literal>
|
|
|
|
docs</link>.
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
The expression generates the needed configuration and writes it into your
|
|
|
|
<literal>/etc/zshrc</literal>.
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<section xml:id="module-programs-oh-my-zsh-additions">
|
|
|
|
<title>Custom additions</title>
|
|
|
|
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
Sometimes third-party or custom scripts such as a modified theme may be
|
|
|
|
needed. <literal>oh-my-zsh</literal> provides the
|
|
|
|
<link xlink:href="https://github.com/robbyrussell/oh-my-zsh/wiki/Customization#overriding-internals"><literal>ZSH_CUSTOM</literal></link>
|
|
|
|
environment variable for this which points to a directory with additional
|
|
|
|
scripts.
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The module can do this as well:
|
2018-08-07 14:38:20 +01:00
|
|
|
<programlisting>
|
|
|
|
{
|
2018-12-17 18:11:40 +00:00
|
|
|
programs.zsh.ohMyZsh.custom = "~/path/to/custom/scripts";
|
2018-08-07 14:38:20 +01:00
|
|
|
}
|
|
|
|
</programlisting>
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<section xml:id="module-programs-oh-my-zsh-environments">
|
|
|
|
<title>Custom environments</title>
|
|
|
|
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
There are several extensions for <literal>oh-my-zsh</literal> packaged in
|
|
|
|
<literal>nixpkgs</literal>. One of them is
|
|
|
|
<link xlink:href="https://github.com/spwhitt/nix-zsh-completions">nix-zsh-completions</link>
|
|
|
|
which bundles completion scripts and a plugin for
|
|
|
|
<literal>oh-my-zsh</literal>.
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
Rather than using a single mutable path for <literal>ZSH_CUSTOM</literal>,
|
|
|
|
it's also possible to generate this path from a list of Nix packages:
|
2018-08-07 14:38:20 +01:00
|
|
|
<programlisting>
|
|
|
|
{ pkgs, ... }:
|
|
|
|
{
|
2018-12-17 18:11:40 +00:00
|
|
|
programs.zsh.ohMyZsh.customPkgs = with pkgs; [
|
2018-08-07 14:38:20 +01:00
|
|
|
pkgs.nix-zsh-completions
|
|
|
|
# and even more...
|
|
|
|
];
|
|
|
|
}
|
|
|
|
</programlisting>
|
2019-09-19 18:17:30 +01:00
|
|
|
Internally a single store path will be created using
|
|
|
|
<literal>buildEnv</literal>. Please refer to the docs of
|
|
|
|
<link xlink:href="https://nixos.org/nixpkgs/manual/#sec-building-environment"><literal>buildEnv</literal></link>
|
|
|
|
for further reference.
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
<emphasis>Please keep in mind that this is not compatible with
|
|
|
|
<literal>programs.zsh.ohMyZsh.custom</literal> as it requires an immutable
|
|
|
|
store path while <literal>custom</literal> shall remain mutable! An
|
|
|
|
evaluation failure will be thrown if both <literal>custom</literal> and
|
|
|
|
<literal>customPkgs</literal> are set.</emphasis>
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<section xml:id="module-programs-oh-my-zsh-packaging-customizations">
|
|
|
|
<title>Package your own customizations</title>
|
|
|
|
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
If third-party customizations (e.g. new themes) are supposed to be added to
|
|
|
|
<literal>oh-my-zsh</literal> there are several pitfalls to keep in mind:
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
To comply with the default structure of <literal>ZSH</literal> the entire
|
|
|
|
output needs to be written to <literal>$out/share/zsh.</literal>
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
Completion scripts are supposed to be stored at
|
|
|
|
<literal>$out/share/zsh/site-functions</literal>. This directory is part
|
|
|
|
of the
|
|
|
|
<literal><link xlink:href="http://zsh.sourceforge.net/Doc/Release/Functions.html">fpath</link></literal>
|
|
|
|
and the package should be compatible with pure <literal>ZSH</literal>
|
|
|
|
setups. The module will automatically link the contents of
|
|
|
|
<literal>site-functions</literal> to completions directory in the proper
|
|
|
|
store path.
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2019-09-19 18:17:30 +01:00
|
|
|
The <literal>plugins</literal> directory needs the structure
|
|
|
|
<literal>pluginname/pluginname.plugin.zsh</literal> as structured in the
|
|
|
|
<link xlink:href="https://github.com/robbyrussell/oh-my-zsh/tree/91b771914bc7c43dd7c7a43b586c5de2c225ceb7/plugins">upstream
|
|
|
|
repo.</link>
|
2018-08-07 14:38:20 +01:00
|
|
|
</para>
|
2018-09-30 01:51:11 +01:00
|
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
2018-08-07 14:38:20 +01:00
|
|
|
|
2018-09-30 01:51:11 +01:00
|
|
|
<para>
|
|
|
|
A derivation for <literal>oh-my-zsh</literal> may look like this:
|
2018-08-07 14:38:20 +01:00
|
|
|
<programlisting>
|
|
|
|
{ stdenv, fetchFromGitHub }:
|
|
|
|
|
|
|
|
stdenv.mkDerivation rec {
|
|
|
|
name = "exemplary-zsh-customization-${version}";
|
|
|
|
version = "1.0.0";
|
|
|
|
src = fetchFromGitHub {
|
|
|
|
# path to the upstream repository
|
|
|
|
};
|
|
|
|
|
|
|
|
dontBuild = true;
|
|
|
|
installPhase = ''
|
|
|
|
mkdir -p $out/share/zsh/site-functions
|
|
|
|
cp {themes,plugins} $out/share/zsh
|
|
|
|
cp completions $out/share/zsh/site-functions
|
|
|
|
'';
|
|
|
|
}
|
|
|
|
</programlisting>
|
2018-09-30 01:51:11 +01:00
|
|
|
</para>
|
|
|
|
</section>
|
2018-08-07 14:38:20 +01:00
|
|
|
</chapter>
|