This commit is contained in:
cjurgell 2025-08-13 14:13:05 -05:00 committed by iofq
parent 58c0637b78
commit 7165161856
10 changed files with 234 additions and 223 deletions

View file

@ -7,195 +7,191 @@
pkgs-wrapNeovim ? pkgs,
}:
with lib;
{
# NVIM_APPNAME - Defaults to 'nvim' if not set.
# If set to something else, this will also rename the binary.
appName ? null,
# The Neovim package to wrap
neovim-unwrapped ? pkgs-wrapNeovim.neovim-unwrapped,
plugins ? [], # List of plugins
# List of dev plugins (will be bootstrapped) - useful for plugin developers
# { name = <plugin-name>; url = <git-url>; }
devPlugins ? [],
# Regexes for config files to ignore, relative to the nvim directory.
# e.g. [ "^plugin/neogit.lua" "^ftplugin/.*.lua" ]
ignoreConfigRegexes ? [],
extraPackages ? [], # Extra runtime dependencies (e.g. ripgrep, ...)
# The below arguments can typically be left as their defaults
# Additional lua packages (not plugins), e.g. from luarocks.org.
# e.g. p: [p.jsregexp]
extraLuaPackages ? p: [],
extraPython3Packages ? p: [], # Additional python 3 packages
withPython3 ? false, # Build Neovim with Python 3 support?
withRuby ? false, # Build Neovim with Ruby support?
withNodeJs ? false, # Build Neovim with NodeJS support?
withSqlite ? true, # Add sqlite? This is a dependency for some plugins
# You probably don't want to create vi or vim aliases
# if the appName is something different than "nvim"
viAlias ? appName == "nvim", # Add a "vi" binary to the build output as an alias?
vimAlias ? appName == "nvim", # Add a "vim" binary to the build output as an alias?
wrapRc ? true,
}: let
# This is the structure of a plugin definition.
# Each plugin in the `plugins` argument list can also be defined as this attrset
defaultPlugin = {
plugin = null; # e.g. nvim-lspconfig
config = null; # plugin config
# If `optional` is set to `false`, the plugin is installed in the 'start' packpath
# set to `true`, it is installed in the 'opt' packpath, and can be lazy loaded with
# ':packadd! {plugin-name}
optional = false;
runtime = {};
};
{
# NVIM_APPNAME - Defaults to 'nvim' if not set.
# If set to something else, this will also rename the binary.
appName ? "nvim",
# The Neovim package to wrap
neovim-unwrapped ? pkgs-wrapNeovim.neovim-unwrapped,
plugins ? [ ], # List of plugins
# List of dev plugins (will be bootstrapped) - useful for plugin developers
# { name = <plugin-name>; url = <git-url>; }
devPlugins ? [ ],
# Regexes for config files to ignore, relative to the nvim directory.
# e.g. [ "^plugin/neogit.lua" "^ftplugin/.*.lua" ]
ignoreConfigRegexes ? [ ],
extraPackages ? [ ], # Extra runtime dependencies (e.g. ripgrep, ...)
# The below arguments can typically be left as their defaults
# Additional lua packages (not plugins), e.g. from luarocks.org.
# e.g. p: [p.jsregexp]
extraLuaPackages ? p: [ ],
extraPython3Packages ? p: [ ], # Additional python 3 packages
withPython3 ? false, # Build Neovim with Python 3 support?
withRuby ? false, # Build Neovim with Ruby support?
withNodeJs ? false, # Build Neovim with NodeJS support?
withSqlite ? true, # Add sqlite? This is a dependency for some plugins
# You probably don't want to create vi or vim aliases
# if the appName is something different than "nvim"
viAlias ? appName == "nvim", # Add a "vi" binary to the build output as an alias?
vimAlias ? appName == "nvim", # Add a "vim" binary to the build output as an alias?
wrapRc ? true,
}:
let
# This is the structure of a plugin definition.
# Each plugin in the `plugins` argument list can also be defined as this attrset
defaultPlugin = {
plugin = null; # e.g. nvim-lspconfig
config = null; # plugin config
# If `optional` is set to `false`, the plugin is installed in the 'start' packpath
# set to `true`, it is installed in the 'opt' packpath, and can be lazy loaded with
# ':packadd! {plugin-name}
optional = false;
runtime = { };
};
externalPackages = extraPackages ++ (optionals withSqlite [pkgs.sqlite]);
externalPackages = extraPackages ++ (optionals withSqlite [ pkgs.sqlite ]);
# Map all plugins to an attrset { plugin = <plugin>; config = <config>; optional = <tf>; ... }
normalizedPlugins = map (x:
defaultPlugin
// (
if x ? plugin
then x
else {plugin = x;}
))
plugins;
# Map all plugins to an attrset { plugin = <plugin>; config = <config>; optional = <tf>; ... }
normalizedPlugins = map (x: defaultPlugin // (if x ? plugin then x else { plugin = x; })) plugins;
# This nixpkgs util function creates an attrset
# that pkgs.wrapNeovimUnstable uses to configure the Neovim build.
neovimConfig = pkgs-wrapNeovim.neovimUtils.makeNeovimConfig {
inherit
extraPython3Packages
withPython3
withRuby
withNodeJs
viAlias
vimAlias
;
plugins = normalizedPlugins;
};
# This nixpkgs util function creates an attrset
# that pkgs.wrapNeovimUnstable uses to configure the Neovim build.
neovimConfig = pkgs-wrapNeovim.neovimUtils.makeNeovimConfig {
inherit
extraPython3Packages
withPython3
withRuby
withNodeJs
viAlias
vimAlias
;
plugins = normalizedPlugins;
};
packDir = pkgs.neovimUtils.packDir {
myNeovimPackages = pkgs.neovimUtils.normalizedPluginsToVimPackage normalizedPlugins;
};
packDir = pkgs.neovimUtils.packDir {
myNeovimPackages = pkgs.neovimUtils.normalizedPluginsToVimPackage normalizedPlugins;
};
# This uses the ignoreConfigRegexes list to filter
# the nvim directory
nvimRtpSrc = let
# This uses the ignoreConfigRegexes list to filter
# the nvim directory
nvimRtpSrc =
let
src = ../nvim;
in
lib.cleanSourceWith {
inherit src;
name = "nvim-rtp-src";
filter = path: tyoe: let
lib.cleanSourceWith {
inherit src;
name = "nvim-rtp-src";
filter =
path: tyoe:
let
srcPrefix = toString src + "/";
relPath = lib.removePrefix srcPrefix (toString path);
in
lib.all (regex: builtins.match regex relPath == null) ignoreConfigRegexes;
};
# Split runtimepath into 3 directories:
# - lua, to be prepended to the rtp at the beginning of init.lua
# - nvim, containing plugin, ftplugin, ... subdirectories
# - after, to be sourced last in the startup initialization
# See also: https://neovim.io/doc/user/starting.html
nvimRtp = stdenv.mkDerivation {
name = "nvim-rtp";
src = nvimRtpSrc;
buildPhase = ''
mkdir -p $out/
'';
installPhase = ''
cp -r . $out/
'';
lib.all (regex: builtins.match regex relPath == null) ignoreConfigRegexes;
};
# The final init.lua content that we pass to the Neovim wrapper.
# It wraps the user init.lua, prepends the lua lib directory to the RTP
# and prepends the nvim and after directory to the RTP
initLua =
''
LAZY_OPTS = {
performance = {
reset_packpath = false,
rtp = {
reset = false,
disabled_plugins = {
"netrwPlugin",
"tutor",
},
},
},
dev = {
path = "${packDir}/pack/myNeovimPackages/start",
patterns = {""},
},
checker = {
enabled = false,
},
install = { missing = false, },
spec = {{ import = "plugins" }},
}
vim.opt.rtp:prepend('${nvimRtp}')
''
+ (builtins.readFile ../nvim/init.lua);
# Split runtimepath into 3 directories:
# - lua, to be prepended to the rtp at the beginning of init.lua
# - nvim, containing plugin, ftplugin, ... subdirectories
# - after, to be sourced last in the startup initialization
# See also: https://neovim.io/doc/user/starting.html
nvimRtp = stdenv.mkDerivation {
name = "nvim-rtp";
src = nvimRtpSrc;
# Add arguments to the Neovim wrapper script
extraMakeWrapperArgs = builtins.concatStringsSep " " (
# Set the NVIM_APPNAME environment variable
(optional (
appName != "nvim" && appName != null && appName != ""
) ''--set NVIM_APPNAME "${appName}"'')
# Add external packages to the PATH
++ (optional (externalPackages != []) ''--prefix PATH : "${makeBinPath externalPackages}"'')
# Set the LIBSQLITE_CLIB_PATH if sqlite is enabled
++ (optional withSqlite ''--set LIBSQLITE_CLIB_PATH "${pkgs.sqlite.out}/lib/libsqlite3.so"'')
# Set the LIBSQLITE environment variable if sqlite is enabled
++ (optional withSqlite ''--set LIBSQLITE "${pkgs.sqlite.out}/lib/libsqlite3.so"'')
);
buildPhase = ''
mkdir -p $out/
'';
luaPackages = neovim-unwrapped.lua.pkgs;
resolvedExtraLuaPackages = extraLuaPackages luaPackages;
installPhase = ''
cp -r . $out/
'';
};
# Native Lua libraries
extraMakeWrapperLuaCArgs =
optionalString (resolvedExtraLuaPackages != [])
# The final init.lua content that we pass to the Neovim wrapper.
# It wraps the user init.lua, prepends the lua lib directory to the RTP
# and prepends the nvim and after directory to the RTP
initLua = ''
LAZY_OPTS = {
performance = {
reset_packpath = false,
rtp = {
reset = false,
disabled_plugins = {
"netrwPlugin",
"tutor",
},
},
},
dev = {
path = "${packDir}/pack/myNeovimPackages/start",
patterns = {""},
},
checker = {
enabled = false,
},
install = { missing = false, },
spec = {{ import = "plugins" }},
}
vim.opt.rtp:prepend('${nvimRtp}')
''
+ (builtins.readFile ../nvim/init.lua);
# Add arguments to the Neovim wrapper script
extraMakeWrapperArgs = builtins.concatStringsSep " " (
# Set the NVIM_APPNAME environment variable
(optional (
appName != "nvim" && appName != null && appName != ""
) ''--set NVIM_APPNAME "${appName}"'')
# Add external packages to the PATH
++ (optional (externalPackages != [ ]) ''--prefix PATH : "${makeBinPath externalPackages}"'')
# Set the LIBSQLITE_CLIB_PATH if sqlite is enabled
++ (optional withSqlite ''--set LIBSQLITE_CLIB_PATH "${pkgs.sqlite.out}/lib/libsqlite3.so"'')
# Set the LIBSQLITE environment variable if sqlite is enabled
++ (optional withSqlite ''--set LIBSQLITE "${pkgs.sqlite.out}/lib/libsqlite3.so"'')
);
luaPackages = neovim-unwrapped.lua.pkgs;
resolvedExtraLuaPackages = extraLuaPackages luaPackages;
# Native Lua libraries
extraMakeWrapperLuaCArgs =
optionalString (resolvedExtraLuaPackages != [ ])
''--suffix LUA_CPATH ";" "${
concatMapStringsSep ";" luaPackages.getLuaCPath resolvedExtraLuaPackages
}"'';
concatMapStringsSep ";" luaPackages.getLuaCPath resolvedExtraLuaPackages
}"'';
# Lua libraries
extraMakeWrapperLuaArgs =
optionalString (resolvedExtraLuaPackages != [])
# Lua libraries
extraMakeWrapperLuaArgs =
optionalString (resolvedExtraLuaPackages != [ ])
''--suffix LUA_PATH ";" "${
concatMapStringsSep ";" luaPackages.getLuaPath resolvedExtraLuaPackages
}"'';
concatMapStringsSep ";" luaPackages.getLuaPath resolvedExtraLuaPackages
}"'';
# wrapNeovimUnstable is the nixpkgs utility function for building a Neovim derivation.
neovim-wrapped = pkgs-wrapNeovim.wrapNeovimUnstable neovim-unwrapped (
neovimConfig
// {
luaRcContent = initLua;
wrapperArgs =
escapeShellArgs neovimConfig.wrapperArgs
+ " "
+ extraMakeWrapperArgs
+ " "
+ extraMakeWrapperLuaCArgs
+ " "
+ extraMakeWrapperLuaArgs;
wrapRc = wrapRc;
}
);
# wrapNeovimUnstable is the nixpkgs utility function for building a Neovim derivation.
neovim-wrapped = pkgs-wrapNeovim.wrapNeovimUnstable neovim-unwrapped (
neovimConfig
// {
luaRcContent = initLua;
wrapperArgs =
escapeShellArgs neovimConfig.wrapperArgs
+ " "
+ extraMakeWrapperArgs
+ " "
+ extraMakeWrapperLuaCArgs
+ " "
+ extraMakeWrapperLuaArgs;
wrapRc = wrapRc;
}
);
isCustomAppName = appName != null && appName != "nvim";
in
neovim-wrapped.overrideAttrs (oa: {
buildPhase =
oa.buildPhase
# If a custom NVIM_APPNAME has been set, rename the `nvim` binary
+ lib.optionalString isCustomAppName ''
mv $out/bin/nvim $out/bin/${lib.escapeShellArg appName}
'';
})
isCustomAppName = appName != null && appName != "nvim";
in
neovim-wrapped.overrideAttrs (oa: {
buildPhase =
oa.buildPhase
# If a custom NVIM_APPNAME has been set, rename the `nvim` binary
+ lib.optionalString isCustomAppName ''
mv $out/bin/nvim $out/bin/${lib.escapeShellArg appName}
'';
})

View file

@ -3,28 +3,13 @@
final: prev:
with final.pkgs.lib;
let
pkgs = final;
pkgs-wrapNeovim = prev;
mkNeovim = prev.callPackage ./mkNeovim.nix { pkgs-wrapNeovim = prev; };
mkNvimPlugin =
src: pname:
pkgs.vimUtils.buildVimPlugin {
inherit pname src;
version = src.lastModifiedDate;
};
mkNeovim = pkgs.callPackage ./mkNeovim.nix { inherit pkgs-wrapNeovim; };
dart-nvim-git = mkNvimPlugin inputs.dart "dart.nvim";
nvim-treesitter-textobjects-git = mkNvimPlugin inputs.nvim-treesitter-textobjects "nvim-treesitter-textobjects";
nvim-treesitter-git = pkgs.vimPlugins.nvim-treesitter.overrideAttrs (old: {
src = inputs.nvim-treesitter;
});
all-plugins = with pkgs.vimPlugins; [
plugins = with final.vimPlugins; [
blink-cmp
blink-ripgrep-nvim
conform-nvim
dart-nvim-git
dart-nvim
diffview-nvim
eyeliner-nvim
friendly-snippets
@ -33,22 +18,21 @@ let
nvim-autopairs
nvim-lint
nvim-lspconfig
nvim-treesitter-git.withAllGrammars
nvim-treesitter.withAllGrammars
nvim-treesitter-context
nvim-treesitter-textobjects-git
nvim-treesitter-textsubjects
nvim-treesitter-textobjects
quicker-nvim
refactoring-nvim
render-markdown-nvim
snacks-nvim
];
basePackages = with pkgs; [
basePackages = with final; [
ripgrep
fd
];
# Extra packages that should be included on nixos but don't need to be bundled
extraPackages = with pkgs; [
extraPackages = with final; [
# linters
yamllint
jq
@ -69,26 +53,20 @@ let
in
{
nvim-pkg = mkNeovim {
plugins = all-plugins;
appName = "nvim";
inherit plugins;
extraPackages = basePackages ++ extraPackages;
withNodeJs = false;
withSqlite = true;
};
nvim-min-pkg = mkNeovim {
plugins = all-plugins;
appName = "nvim";
inherit plugins;
extraPackages = basePackages;
withNodeJs = false;
withSqlite = true;
};
# This is meant to be used within a devshell.
# Instead of loading the lua Neovim configuration from
# the Nix store, it is loaded from $XDG_CONFIG_HOME/nvim-dev
nvim-dev = mkNeovim {
plugins = all-plugins;
inherit plugins;
extraPackages = basePackages ++ extraPackages;
appName = "nvim-dev";
wrapRc = false;
@ -96,6 +74,6 @@ in
# This can be symlinked in the devShell's shellHook
nvim-luarc-json = final.mk-luarc-json {
plugins = all-plugins;
inherit plugins;
};
}

29
nix/plugin-overlay.nix Normal file
View file

@ -0,0 +1,29 @@
{ inputs, ... }:
final: prev:
let
mkNvimPlugin =
src: pname:
prev.vimUtils.buildVimPlugin {
inherit pname src;
version = src.lastModifiedDate;
};
in
{
vimPlugins = prev.vimPlugins.extend (
final': prev': {
dart-nvim = mkNvimPlugin inputs.dart "dart.nvim";
nvim-treesitter-textobjects = mkNvimPlugin inputs.nvim-treesitter-textobjects "nvim-treesitter-textobjects";
nvim-treesitter = prev'.nvim-treesitter.overrideAttrs (old: rec {
src = inputs.nvim-treesitter;
name = "${old.pname}-${src.rev}";
postPatch = "";
# ensure runtime queries get linked to RTP (:TSInstall does this too)
buildPhase = "
mkdir -p $out/queries
cp -a $src/runtime/queries/* $out/queries
";
nvimSkipModules = [ "nvim-treesitter._meta.parsers" ];
});
}
);
}