"Opts" Table Pass

[suasuasuasuasua]

I recently learned that you can use both opts and config with lazy.nvim (see post). opts is passed as an argument to the config function if opts and config are set. Otherwise, opts is automatically passed as an argument to the plugin's setup function.

-- https://www.reddit.com/r/neovim/comments/14ue6x5/comment/jr7419o/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button
config = function(_, opts)
    ...
end

It seems like we do a similar thing with lz-n when lazy loading (see docs).

By default, we route the generated setup code to your lazy loading provider, but it can be overridden by using the lazyLoad.settings option.

For Lz.n, the lazyLoad.settings.after option contains what it will call when a trigger condition is met.

Is it possible to access that "setup code" (the table) in a function given to after? I'm not sure if that's documented anywhere, and I'm not at my main computer where I can test it.

For example,

plugins.X = {
  settings = { foo = "bar"; };
  lazyLoad.settings = {
    # lz.n equivalent to config (lazy.nvim)
    after =
      # lua
      ''
        function(opts) -- TODO: is there an optional argument here to access the "settings" table too?
          -- setup the plugin with that table
          require("X").setup(opts)
          
          -- do something else
          -- ...
        end
      '';
  };
};

Or does it make more sense to do something like luaConfig.post?

Thank you.

[MattSturgeon]

By default, nixvim's plugins will put their luaConfig into lz-n's after (when lazyloading).

So if you want to use Nixvim's plugin settings, you should put your "after" code in plugins.*.luaConfig.

So:

Or does it make more sense to do something like luaConfig.post?

is correct.

---

If you define plugins.*.lazyload.settings.after explicitly for this plugin, then that overrides everything nixvim would've done. This effectively means your plugins.*.settings is ignored, and if you wanted to use it you'd have to use toLuaObject on it yourself.

See

nixvim/lib/plugins/mk-neovim-plugin.nix

Lines 127 to 132 in d2c3b26

	after =
	let
	after = cfg.lazyLoad.settings.after or null;
	default = if hasLuaConfig then "function()\n " + cfg.luaConfig.content + " \nend" else null;
	in
	if (lib.isString after || lib.types.rawLua.check after) then after else default;

(Sorry for the late reply!)

[GaetanLepage]

Does that answer your question @suasuasuasuasua?

[suasuasuasuasua]

Yes, I think what @MattSturgeon wrote makes sense. Sorry I forgot to mark the answer completed!

[GaetanLepage]

Cool!