Motivation for this change

Last week I improved several parts of the ZSH module. However I didn't find enough time to implement custom pattern support for zsh-syntax-highlighting which I managed to do now.

I checked all configurations using the following command:

NIXOS_CONFIG=`pwd`/vmtest.nix nixos-rebuild -I nixpkgs=$HOME/Projects/nixpkgs/ build-vm

• Test with proper configuration
  It works fine when using a configuration like this:

{
  # ...
  programs.zsh = {
    enable = true;

    syntax-highlighting = {
      enable = true;
      highlighters = [ "main" "pattern" ];
      patterns = [
        ["rm -rf *" "fg=white,bold,bg=red"]
        ["vim *" "fg=white"]
      ];
    };
  };
}

• Assertion: it should break when configuring patterns, but the highlighters option doesn't contain the pattern highlighter:

{
  # ...
  programs.zsh = {
    enable = true;

    syntax-highlighting = {
      enable = true;
      highlighters = [ "main" ];
      patterns = [
        ["rm -rf *" "fg=white,bold,bg=red"]
        ["vim *" "fg=white"]
      ];
    };
  };

}

• Assertion: it should break if a pattern contains more than two elements of type string (it seems as nix doesn't know tuples, so I had to write an assertion to ensure that only two elements are present in the list which represents one highlight pattern):

{
  # ...
  programs.zsh = {
    enable = true;

    syntax-highlighting = {
      enable = true;
      highlighters = [ "main" "pattern" ];
      patterns = [
        ["rm -rf *" "fg=white,bold,bg=red" "blub" "foo"]
      ];
    };
  };

}

Things done

• Tested using sandboxing
  (nix.useSandbox on NixOS,
  or option build-use-sandbox in nix.conf
  on non-NixOS)
• Built on platform(s)
  • NixOS
  • macOS
  • Linux
• Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
• Tested execution of all binary files (usually in ./result/bin/)
• Fits CONTRIBUTING.md.