neovim: enable use of external package manager (#5225)

* neovim: add extraWrapperArgs option pass external arguments to neovim-unwrapper this gives users more flexibility in managing neovim configuration * neovim: add test for `extraWrapperArgs`
nix-community · Apr 13, 2024 · 8fdf329 · 8fdf329
1 parent 40ab43a
commit 8fdf329
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 1 deletion.
diff --git a/modules/programs/neovim.nix b/modules/programs/neovim.nix
@@ -198,6 +198,28 @@ in {
         '';
       };
 
+      extraWrapperArgs = mkOption {
+        type = with types; listOf str;
+        default = [ ];
+        example = literalExpression ''
+          [
+            "--suffix"
+            "LIBRARY_PATH"
+            ":"
+            "''${lib.makeLibraryPath [ pkgs.stdenv.cc.cc pkgs.zlib ]}"
+            "--suffix"
+            "PKG_CONFIG_PATH"
+            ":"
+            "''${lib.makeSearchPathOutput "dev" "lib/pkgconfig" [ pkgs.stdenv.cc.cc pkgs.zlib ]}"
+          ]
+        '';
+        description = ''
+          Extra arguments to be passed to the neovim wrapper.
+          This option sets environment variables required for building and running binaries
+          with external package managers like mason.nvim.
+        '';
+      };
+
       generatedConfigViml = mkOption {
         type = types.lines;
         visible = true;
@@ -415,7 +437,8 @@ in {
 
     programs.neovim.finalPackage = pkgs.wrapNeovimUnstable cfg.package
       (neovimConfig // {
-        wrapperArgs = (lib.escapeShellArgs neovimConfig.wrapperArgs) + " "
+        wrapperArgs = (lib.escapeShellArgs
+          (neovimConfig.wrapperArgs ++ cfg.extraWrapperArgs)) + " "
           + extraMakeWrapperArgs + " " + extraMakeWrapperLuaCArgs + " "
           + extraMakeWrapperLuaArgs;
         wrapRc = false;

diff --git a/tests/modules/programs/neovim/runtime.nix b/tests/modules/programs/neovim/runtime.nix
@@ -20,6 +20,17 @@ with lib;
             };
           }
         ];
+        extraWrapperArgs = let buildDeps = with pkgs; [ stdenv.cc.cc zlib ];
+        in [
+          "--suffix"
+          "LIBRARY_PATH"
+          ":"
+          "${lib.makeLibraryPath buildDeps}"
+          "--suffix"
+          "PKG_CONFIG_PATH"
+          ":"
+          "${lib.makeSearchPathOutput "dev" "lib/pkgconfig" buildDeps}"
+        ];
       }
       {
         extraPython3Packages = ps: with ps; [ jedi pynvim ];
@@ -33,7 +44,10 @@ with lib;
 
     nmt.script = ''
       ftplugin="home-files/.config/nvim/after/ftplugin/c.vim"
+      nvimbin="home-path/bin/nvim"
       assertFileExists "$ftplugin"
+      assertFileRegex "$nvimbin" 'LIBRARY_PATH'
+      assertFileRegex "$nvimbin" 'PKG_CONFIG_PATH'
     '';
   };
 }