1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-25 03:09:47 +01:00

zsh: add plugins submodule

To pass compinit security checks,
plugins are liked into ~/zsh/plugins folder.
This also solves issues with a slow start up,
see https://github.com/rycee/home-manager/pull/56#issuecomment-328057513.
This commit is contained in:
Robin Stumm 2017-09-04 16:39:14 +02:00 committed by Nikita Uvarov
parent fc1d4f5362
commit 258bc85b9c
No known key found for this signature in database
GPG key ID: F7A5FB3A7C10EF96
2 changed files with 94 additions and 6 deletions

View file

@ -107,6 +107,15 @@ in
config = { config = {
news.entries = [ news.entries = [
{
time = "2017-09-10T22:15:19+00:00";
condition = config.programs.zsh.enable;
message = ''
Home Manager now offers its own minimal zsh plugin manager
under the 'programs.zsh.plugins' option path. By statically
sourcing your plugins it achieves no startup overhead.
'';
}
{ {
time = "2017-09-01T10:56:28+00:00"; time = "2017-09-01T10:56:28+00:00";
message = '' message = ''

View file

@ -37,6 +37,36 @@ let
}; };
}; };
pluginModule = types.submodule ({ config, ... }: {
options = {
src = mkOption {
type = types.path;
description = ''
Path to the plugin folder.
Will be added to <envar>fpath</envar> and <envar>PATH</envar>.
'';
};
name = mkOption {
type = types.str;
description = ''
The name of the plugin.
Don't forget to add <option>file</option>
if the script name does not follow convention.
'';
};
file = mkOption {
type = types.str;
description = "The plugin script to source.";
};
};
config.file = mkDefault "${config.name}.plugin.zsh";
});
in in
{ {
@ -74,13 +104,43 @@ in
initExtra = mkOption { initExtra = mkOption {
default = ""; default = "";
type = types.lines; type = types.lines;
description = "Extra commands that should be added to .zshrc."; description = "Extra commands that should be added to <filename>.zshrc</filename>.";
};
plugins = mkOption {
type = types.listOf pluginModule;
default = [];
example = literalExample ''
[
{
# will source zsh-autosuggestions.plugin.zsh
name = "zsh-autosuggestions";
src = pkgs.fetchFromGitHub {
owner = "zsh-users";
repo = "zsh-autosuggestions";
rev = "v0.4.0";
sha256 = "0z6i9wjjklb4lvr7zjhbphibsyx51psv50gm07mbb0kj9058j6kc";
};
}
{
name = "enhancd";
file = "init.sh";
src = pkgs.fetchFromGitHub {
owner = "b4b4r07";
repo = "enhancd";
rev = "v2.2.1";
sha256 = "0iqa9j09fwm6nj5rpip87x3hnvbbz9w9ajgm6wkrd5fls8fn8i5g";
};
}
]
'';
description = "Plugins to source in <filename>.zshrc</filename>.";
}; };
}; };
}; };
config = ( config = mkMerge [
let (let
aliasesStr = concatStringsSep "\n" ( aliasesStr = concatStringsSep "\n" (
mapAttrsToList (k: v: "alias ${k}='${v}'") cfg.shellAliases mapAttrsToList (k: v: "alias ${k}='${v}'") cfg.shellAliases
); );
@ -109,15 +169,34 @@ in
HELPDIR="${pkgs.zsh}/share/zsh/$ZSH_VERSION/help" HELPDIR="${pkgs.zsh}/share/zsh/$ZSH_VERSION/help"
${if cfg.enableCompletion then "autoload -U compinit && compinit" else ""} ${concatStrings (map (plugin: ''
path+="$HOME/.zsh/plugins/${plugin.name}"
fpath+="$HOME/.zsh/plugins/${plugin.name}"
'') cfg.plugins)}
${optionalString cfg.enableCompletion "autoload -U compinit && compinit"}
${optionalString (cfg.enableAutosuggestions) ${optionalString (cfg.enableAutosuggestions)
"source ${pkgs.zsh-autosuggestions}/share/zsh-autosuggestions/zsh-autosuggestions.zsh" "source ${pkgs.zsh-autosuggestions}/share/zsh-autosuggestions/zsh-autosuggestions.zsh"
} }
${concatStrings (map (plugin: ''
source "$HOME/.zsh/plugins/${plugin.name}/${plugin.file}"
'') cfg.plugins)}
${aliasesStr} ${aliasesStr}
${cfg.initExtra} ${cfg.initExtra}
''; '';
} })
); (mkIf (cfg.plugins != []) {
# Many plugins require compinit to be called
# but allow the user to opt out.
programs.zsh.enableCompletion = mkDefault true;
home.file = map (plugin: {
target = ".zsh/plugins/${plugin.name}";
source = plugin.src;
}) cfg.plugins;
})
];
} }