neovim: make the derivation more composable #344541

teto · 2024-09-25T22:55:15Z

Now that we have structured attributes enabled, it's easier than ever to
access the wrapper config from itself. Let's expose the plugins instead
of the packpathDir with which one can't do much.

With exposed plugins, one could tweak the current wrapper with more
plugins, e.g. neovim.withPlugins([fugitive]).withPlugins([plenary]) .
we could also add a boolean to autoadd the plugins passthru.initLua,
better handle the dependencies (runtime programs, python deps).
�

Description of changes

Things done

Add a 👍 reaction to pull requests you find important.

MattSturgeon

(comments and questions only)

MattSturgeon · 2024-09-29T21:41:54Z

pkgs/applications/editors/neovim/utils.nix

+        # TODO use (coercedTo package (v: { plugin = v; }) pluginWithConfigType);
        map (x: defaultPlugin // (if (x ? plugin) then x else { plugin = x; })) plugins;


Q: is there a module option somewhere that relates to this? I'm struggling to see how types.coercedTo is relevant otherwise

I have some local code that uses nixosModule to generate the neovim config. Sadly I cant ever seem to finish it. It's not releveant here I will remove the comment

MattSturgeon · 2024-09-29T21:46:30Z

pkgs/applications/editors/neovim/wrapper.nix

  assert withPython2 -> throw "Python2 support has been removed from the neovim wrapper, please remove withPython2 and python2Env.";

+  # assert packpathDirs -> throw "Packpathdirs removed";


Suggested change

# assert packpathDirs -> throw "Packpathdirs removed";

assert lib.assertMsg (attrs ? packpathDirs) "packpathDirs removed";

I believe best practice though would be to remove the ... so that only supported args can be passed? Unless the args truly can be anything and will be passed on to another function.

funny I am of the opposite opinion ^^' it lets the package be forward and backward compatible (you can mix different versions of nixpkgs) and add warnings such as this one.

I believe best practice though would be to remove the ... so that only supported args can be passed?

I believe I was advised this when contributing to /lib. EDIT: #315411 (comment)

IIRC the argument was something along the lines of: it's better for the function signature to not be forward/backward compatible in ways that the function itself is not.

e.g. if someone uses a feature of the function that is supported by a newer nixpkgs than they have, they would not know that the feature has no effect.

Backwards compatibility can still be achieved by keeping stub foo ? null, parameters in the signature, but forward compatibility is more difficult because we don't know what will be added in the future.

Either way, the ... isn't added by this PR, so this isn't feedback on the PR itself, just commenting on the existing code 🙃

MattSturgeon · 2024-09-29T21:48:41Z

pkgs/applications/editors/neovim/wrapper.nix


    finalPackdir = neovimUtils.packDir packpathDirs;

    rcContent = ''
      ${luaRcContent}
-    '' + lib.optionalString (!isNull neovimRcContent) ''
-      vim.cmd.source "${writeText "init.vim" neovimRcContent}"
+    '' + lib.optionalString (!isNull neovimRcContent') ''


IIRC isNull is deprecated, if the line is being touched anyway we can migrate to != null?

didn't know about that: do you have a reference ? isNull is a builtins so I am surprised it gets removed. But yeah np problem for changing it to != null

There's a warning on Noogle and nix.dev. Not a big deal but better to avoid usage if possible 🙂

MattSturgeon · 2024-09-29T21:55:10Z

pkgs/applications/editors/neovim/wrapper.nix

+      ++ (lib.concatMap (f: f ps) pluginPython3Packages));
+
+    packpathDirs.myNeovimPackages = myVimPackage;
+
    wrapperArgsStr = if lib.isString wrapperArgs then wrapperArgs else lib.escapeShellArgs wrapperArgs;


Would it be useful to also have a runtimeInputs or dependencies argument that prepends to PATH via the wrapper?

totally. This will be unblocked by this PR. I prefer it to be done as a follow up though since neovim is a touchy derivation: you quickly know when you break something xD and this has the potential to break configs already (at least for people using the "private/unstable" APIs)

khaneliman · 2024-10-05T03:44:44Z

pkgs/applications/editors/neovim/utils.nix

-    , withNodeJs ? false
-    , withRuby ? true
-    /* the function you would have passed to lua.withPackages */
-    , extraLuaPackages ? (_: [ ])


What's the new expected way of handling adding extraLuaPackages to a config? I didn't see this argument moved to the wrapper like extraPython3Packages was.

In relation to https://buildbot.nix-community.org/#/builders/2809/builds/1218 trying to figure out what we need to change in https://github.com/nix-community/nixvim/blob/0ca98d02104f7f0a703787a7a080a570b7f1bedd/modules/top-level/output.nix#L266

you are absolutely correct. I would like to avoid adding them to the wrapper as extraLuaPackages was a workaround to specify plugin dependencies. Lua dependencies are now loaded correctly in the wrapper via shell hooks. A user could call the wrapper directly adding its own wrapper args to add externmal lua dependencies or convert a lua package with buildNeovimPlugin

if you could trigger the nnixvim job again, hopefully it is now fixed.

Cool, kicking off another build there

Now that we have structured attributes enabled, it's easier than ever to access the wrapper config from itself. Let's expose the 'plugins' derivations instead of the final 'packpathDir' with which one can't do much. TLDR: the neovim wrapper accepts a list of neovim derivations in `plugins` instead of the symlinkJoin of plugins in `packpathDir`. With exposed plugins, one could tweak the current wrapper with more plugins, e.g. neovim.withPlugins([fugitive]).withPlugins([plenary]) . we could also add a boolean to autoadd the plugins passthru.initLua, better handle the dependencies (runtime programs, python deps).

khaneliman · 2024-10-06T22:55:09Z

pkgs/applications/editors/neovim/wrapper.nix

@@ -19,9 +23,12 @@ let
    # should contain all args but the binary. Can be either a string or list
    , wrapperArgs ? []
    # a limited RC script used only to generate the manifest for remote plugins
-    , manifestRc ? null
+    # , manifestRc ? null


Was something meant to be noted here for commenting this out?

ty for spotting this, I removed it, it's generated a bit later in the wrapper.

github-actions bot added the 6.topic: vim label Sep 25, 2024

teto changed the title ~~neovim: make the wrapper more evolvable~~ neovim: make the derivation more composable Sep 25, 2024

ofborg bot added 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Sep 26, 2024

MattSturgeon reviewed Sep 29, 2024

View reviewed changes

MattSturgeon mentioned this pull request Sep 29, 2024

test-teto-fork nix-community/nixvim#2343

Open

PerchunPak mentioned this pull request Oct 1, 2024

vimPlugins.kulala-nvim: init at 2024-09-30 #332758

Merged

13 tasks

teto force-pushed the teto/neovim-move-plugins-to-wrapper branch from 4ba0a81 to 857dad5 Compare October 3, 2024 22:05

teto marked this pull request as ready for review October 3, 2024 22:13

teto requested a review from figsoda as a code owner October 3, 2024 22:13

khaneliman reviewed Oct 5, 2024

View reviewed changes

teto added 2 commits October 7, 2024 00:47

fixup! neovim: make the wrapper more evolvable

4ebef43

teto force-pushed the teto/neovim-move-plugins-to-wrapper branch from 857dad5 to 4ebef43 Compare October 6, 2024 22:50

khaneliman reviewed Oct 6, 2024

View reviewed changes

fixup! fixup! neovim: make the wrapper more evolvable

e6388b4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

neovim: make the derivation more composable #344541

neovim: make the derivation more composable #344541

teto commented Sep 25, 2024

MattSturgeon left a comment

MattSturgeon Sep 29, 2024

teto Oct 2, 2024

MattSturgeon Sep 29, 2024

teto Oct 2, 2024

MattSturgeon Oct 3, 2024 •

edited

Loading

MattSturgeon Sep 29, 2024

teto Oct 2, 2024

MattSturgeon Oct 3, 2024

MattSturgeon Sep 29, 2024

teto Oct 2, 2024

khaneliman Oct 5, 2024

khaneliman Oct 5, 2024

teto Oct 6, 2024

teto Oct 6, 2024

khaneliman Oct 6, 2024

khaneliman Oct 6, 2024

teto Oct 6, 2024

		# TODO use (coercedTo package (v: { plugin = v; }) pluginWithConfigType);
		map (x: defaultPlugin // (if (x ? plugin) then x else { plugin = x; })) plugins;

		assert withPython2 -> throw "Python2 support has been removed from the neovim wrapper, please remove withPython2 and python2Env.";

		# assert packpathDirs -> throw "Packpathdirs removed";

	# assert packpathDirs -> throw "Packpathdirs removed";
	assert lib.assertMsg (attrs ? packpathDirs) "packpathDirs removed";

neovim: make the derivation more composable #344541

Are you sure you want to change the base?

neovim: make the derivation more composable #344541

Conversation

teto commented Sep 25, 2024

Description of changes

Things done

MattSturgeon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MattSturgeon Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MattSturgeon Oct 3, 2024 •

edited

Loading