feature: user autocmd event when syncing/updating is complete

[mehalter]

Did you check docs the docs?

• I have read all the lazy docs

Is your feature request related to a problem? Please describe.

It would be nice to have autocmd user events when lazy finishes updating/installing plugins so the user can easily trigger things to happen.

Describe the solution you'd like

After an update/install is finished and all of the install handlers are finished do something like vim.cmd("do User LazyComplete") or some other name to indicate it has finished updating/installing plugins.

Describe alternatives you've considered

I'm not sure of any other alternatives to be able to tell when Lazy is finished.

Additional context

This is also useful if a user wants to do a headless setup of their neovim config on a fresh install with something like nvim --headless -c 'autocmd User LazyComplete quitall'

This is also something that other package managers do like Packer which emits the user event PackerComplete

[folke]

for headless install you can do nvim --headless "+Lazy! sync" +qa as is mentioned in the docs.

You can also use the API and pass in wait=true to wait till the operation finishes.

The user commands can be executed with a bang, which makes them also wait till they finished.

It's all in the docs.

What's your specific use-case?

There is also LazyDone which is triggered when lazy is finished setting up during startup. Need to document that one.

[kylo252]

What's your specific use-case?

@folke, it would be useful for pseudo hot-reloading, e,g. refreshing elements of the UI after the plugins have been updated.

  vim.api.nvim_create_autocmd("User", {
    pattern = "LazyComplete",
    once = true,
    callback = function()
        vim.api.nvim_exec_autocmds("ColorScheme", {pattern = "*"})
		-- vim.notify("Update/Sync/Something is complete!")
    end,
  })

[folke]

📆 User Events

The following user events will be triggered:

• LazyDone: when lazy has finished starting up and loaded your config
• LazySync: after running sync
• LazyInstall: after an install
• LazyUpdate: after an update
• LazyClean: after a clean
• LazyCheck: after checking for updates
• LazyLog: after running log

[mosheavni]

Pardon @folke but isn't VeryLazy one of them?

[folke]

Right, need to add that one to the list