mirror of
https://github.com/SebastianWendel/nixpkgs.git
synced 2024-09-30 00:50:17 +02:00
2eb1610725
Current nixpkgs always wraps neovim with the "-u" which has sideeffects as explained in https://github.com/NixOS/nixpkgs/issues/55376 : 1. vim won't set the variable $MYVIMRC as explained #34215 2. vim skips loading folder-specific .vimrc / .nvimrc I wanted to provide a way for users to better control what flags are used to wrap neovim. This is achived by introducing wrapNeovimUnstable et neovimUtils, utilities to help with that. We provide a compatibility layer so that wrapNeovim still works and to let us experiment with wrapNeovimUnstable to better control neovim configuration, plugin dependencies, haskell environment etc so that it becomes easier to generate per-project neovim config. With this commit, it's possible for instance for home-manager to wrap neovim without the `-u` and just write the config in the expected $XDG_CONFIG_HOME/nvim/init.vim . Expect wrapNeovimUnstable interface to evolve in the upcoming months.
122 lines
4.3 KiB
Nix
122 lines
4.3 KiB
Nix
{ stdenv, symlinkJoin, lib, makeWrapper
|
|
, vimUtils
|
|
, writeText
|
|
, bundlerEnv, ruby
|
|
, nodejs
|
|
, nodePackages
|
|
, pythonPackages
|
|
, python3Packages
|
|
}:
|
|
with stdenv.lib;
|
|
|
|
neovim:
|
|
|
|
let
|
|
wrapper = {
|
|
# should contain all args but the binary
|
|
wrapperArgs ? []
|
|
, manifestRc ? null
|
|
, withPython2 ? true, python2Env ? null
|
|
, withPython3 ? true, python3Env ? null
|
|
, withNodeJs? false
|
|
, withRuby ? true, rubyEnv ? null
|
|
, vimAlias ? false
|
|
, viAlias ? false
|
|
, ...
|
|
}:
|
|
let
|
|
|
|
# If configure != {}, we can't generate the rplugin.vim file with e.g
|
|
# NVIM_SYSTEM_RPLUGIN_MANIFEST *and* NVIM_RPLUGIN_MANIFEST env vars set in
|
|
# the wrapper. That's why only when configure != {} (tested both here and
|
|
# when postBuild is evaluated), we call makeWrapper once to generate a
|
|
# wrapper with most arguments we need, excluding those that cause problems to
|
|
# generate rplugin.vim, but still required for the final wrapper.
|
|
finalMakeWrapperArgs =
|
|
[ "${neovim}/bin/nvim" "${placeholder "out"}/bin/nvim" ] ++ wrapperArgs ++
|
|
[ "--set" "NVIM_SYSTEM_RPLUGIN_MANIFEST" "${placeholder "out"}/rplugin.vim" ];
|
|
in
|
|
symlinkJoin {
|
|
name = "neovim-${stdenv.lib.getVersion neovim}";
|
|
# Remove the symlinks created by symlinkJoin which we need to perform
|
|
# extra actions upon
|
|
postBuild = lib.optionalString stdenv.isLinux ''
|
|
rm $out/share/applications/nvim.desktop
|
|
substitute ${neovim}/share/applications/nvim.desktop $out/share/applications/nvim.desktop \
|
|
--replace 'TryExec=nvim' "TryExec=$out/bin/nvim" \
|
|
--replace 'Name=Neovim' 'Name=WrappedNeovim'
|
|
''
|
|
+ optionalString withPython2 ''
|
|
makeWrapper ${python2Env}/bin/python $out/bin/nvim-python --unset PYTHONPATH
|
|
''
|
|
+ optionalString withPython3 ''
|
|
makeWrapper ${python3Env}/bin/python3 $out/bin/nvim-python3 --unset PYTHONPATH
|
|
''
|
|
+ optionalString withRuby ''
|
|
ln -s ${rubyEnv}/bin/neovim-ruby-host $out/bin/nvim-ruby
|
|
''
|
|
+ optionalString withNodeJs ''
|
|
ln -s ${nodePackages.neovim}/bin/neovim-node-host $out/bin/nvim-node
|
|
''
|
|
+ optionalString vimAlias ''
|
|
ln -s $out/bin/nvim $out/bin/vim
|
|
''
|
|
+ optionalString viAlias ''
|
|
ln -s $out/bin/nvim $out/bin/vi
|
|
''
|
|
+ optionalString (manifestRc != null) (let
|
|
manifestWrapperArgs =
|
|
[ "${neovim}/bin/nvim" "${placeholder "out"}/bin/nvim-wrapper" ] ++ wrapperArgs;
|
|
in ''
|
|
echo "Generating remote plugin manifest"
|
|
export NVIM_RPLUGIN_MANIFEST=$out/rplugin.vim
|
|
makeWrapper ${lib.escapeShellArgs manifestWrapperArgs}
|
|
|
|
# Some plugins assume that the home directory is accessible for
|
|
# initializing caches, temporary files, etc. Even if the plugin isn't
|
|
# actively used, it may throw an error as soon as Neovim is launched
|
|
# (e.g., inside an autoload script), causing manifest generation to
|
|
# fail. Therefore, let's create a fake home directory before generating
|
|
# the manifest, just to satisfy the needs of these plugins.
|
|
#
|
|
# See https://github.com/Yggdroot/LeaderF/blob/v1.21/autoload/lfMru.vim#L10
|
|
# for an example of this behavior.
|
|
export HOME="$(mktemp -d)"
|
|
# Launch neovim with a vimrc file containing only the generated plugin
|
|
# code. Pass various flags to disable temp file generation
|
|
# (swap/viminfo) and redirect errors to stderr.
|
|
# Only display the log on error since it will contain a few normally
|
|
# irrelevant messages.
|
|
if ! $out/bin/nvim-wrapper \
|
|
-u ${writeText "manifest.vim" manifestRc} \
|
|
-i NONE -n \
|
|
-E -V1rplugins.log -s \
|
|
+UpdateRemotePlugins +quit! > outfile 2>&1; then
|
|
cat outfile
|
|
echo -e "\nGenerating rplugin.vim failed!"
|
|
exit 1
|
|
fi
|
|
rm "${placeholder "out"}/bin/nvim-wrapper"
|
|
'')
|
|
+ ''
|
|
rm $out/bin/nvim
|
|
makeWrapper ${lib.escapeShellArgs finalMakeWrapperArgs}
|
|
'';
|
|
|
|
paths = [ neovim ];
|
|
|
|
preferLocalBuild = true;
|
|
|
|
buildInputs = [makeWrapper];
|
|
passthru = { unwrapped = neovim; };
|
|
|
|
meta = neovim.meta // {
|
|
# To prevent builds on hydra
|
|
hydraPlatforms = [];
|
|
# prefer wrapper over the package
|
|
priority = (neovim.meta.priority or 0) - 1;
|
|
};
|
|
};
|
|
in
|
|
lib.makeOverridable wrapper
|