I think I'm not fully understanding the LazyLoad event key

[plongitudes]

I feel like I must be missing something obvious, as I'm having trouble either understanding or implementing the "LazyLoad" user event. My goal is to ensure correct load order of mason.nvim, mason-lspconfig.nvim, and nvim-lspconfig.

Plugins are loading fine, just not in the right order -- invariably, it seems to be alphabetically by how each plugin/file is named.

In the docs, the "LazyLoad" event is described as:

LazyLoad: after loading a plugin. The data attribute will contain the plugin name.

I've interpreted this as "plugins with the LazyLoad spec specified will load after the named plugins in the data attribute". I hope I've got that right. I thought that this would work:

{
  'neovim/nvim-lspconfig',
  event = {
    'LazyLoad',
    data = {
      'williamboman/mason.nvim'
    },
  },
  config = function()
    <...>
  end
}

but it doesn't seem to affect load order at all. I admit I'm not a lua expert, but I could also just be completely misunderstanding the function of the LazyLoad event. Much obliged for any help anyone can offer. :) Thanks!

[pynappo]

does event take a data table? i wasn't aware of that.

anyways i personally resolve load order by adding mason-lspconfig as a dependency for lspconfig and mason as a dependency for mason-lspconfig. Then i have a separate plugin spec for mason to un-lazyload it.

my understanding is that after a plugin is loaded and before its config() is run, the dependencies are loaded and their configs are run.

[plongitudes]

When I posted, I wasn't sure if attribute meant a table or not, I was just taking a stab in the dark. I was a little confused by the section about User Events, and assumed that they were the same as the event key in the plugin spec?

Regardless, I like your solution, and I'm happy to steal copy it for my own uses, at least until I understand better if the "LazyLoad" User Event does what I thought it did or not :)

[abeldekat]

Hello @plongitudes,

The event property in the plugin specification does not take a data table:

Lazy-load on event. Events can be specified as BufEnter or with a pattern like BufEnter *.lua

string? or string[] or fun(self:LazyPlugin, event:string[]):string[]

The LazyLoad event was added fairly recently.

An example of its usage can be found in LazyVim. In this code fragment, the event is used to require the which-key plugin only when it is loaded. This effectively decouples the lazy-loading of mini.ai and which-key.
If a plugin A requires a plugin B directly, than plugin B always loads when plugin A loads. Thus plugin A imposes its loading specification(event, keys, cmd, ft) on plugin B.

As @pynappo indicated, you can use the dependency property:

A list of plugin names or plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise. When specifying a name, make sure the plugin spec has been defined somewhere else.

You could peek at the lsp setup in LazyVim

Worth mentioning: An explanation on how dependencies are loaded, written by Folke in this issue.

Best regards!

[plongitudes]

Thanks for taking the time to explain and write all that out :)

I feel like I must still be missing a link somewhere -- I see what was done in e212c16 to decouple which-key and mini.ai, but from reading the commit you pointed to, it looks like it's leveraging on_load(), which as far as I can tell is not the same as 9fd8970 (though the same release), but I did see that it was mentioned that the LazyLoad event from lazy.nvim was leveraged in LazyVim, but I'm having trouble seeing from the two commits how they're related.

Granted, it's late where I am and I might not be reading correctly.

... Actually, I get now that you're referencing event from the spec, and what I'm referring to is here, lower down in the docs. Am I off-base and 'user events' are different than event from the plugin spec? That may be where I'm going wrong. I couldn't find any clarification on if they're the same or not, so maybe I made an incorrect assumption there.

And now that I'm reading 9fd8970 more closely, I think I need to read up more on AutoCmds, but I'm still not 100% on things. That's more of a me problem, maybe.

All that aside, I do like the convenience there of the on_load() method.

[abeldekat]

... but I'm having trouble seeing from the two commits how they're related

The on_load function in lazyvim.util uses the LazyLoad event broadcasted by lazy.nvim, introduced in this commit: LazyLoad

... Am I off-base and 'user events' are different than event from the plugin spec...

The User Events section describes all user events triggered by lazy.nvim during its various stages of processing.
Most of those events, in my opinion, are not primarily intended to be used in the event property of your plugin spec. For example, it makes no sense to lazy-load your plugin on the User LazyLog event.

VeryLazy though, is most useful in the event property of your specs.
Lazy.nvim even translates event = "VeryLazy" into event = "User VeryLazy" internally, see event.lua

[plongitudes]

I get it now, thank you. I was seeing the User Event functionality backwards, but they're signals to be consumed, not levers that do specific things per se.

Not specifically what I was looking for, but I understand this part now :D