feature: guidance request / documentation

[michaelrommel]

Did you check the docs?

• I have read all the lazy.nvim docs

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

There is not a problem with lazy. I created a plugin and made a naming / namespace mistake, that I'd like to correct without breaking peoples installations.

Describe the solution you'd like

I am looking for some guidance, how I could rename the module. My module has a github repo nvim-silicon but mistakenly when I first created the module I created the lua directory silicon. Now to avoid name clashes I would like to rename it also to nvim-silicon but in their lazy configs the people already have require('silicon')....

Is there some guidance available how to smoothly create deprecation notices and give people time to move their configs to the new naming scheme?

Describe alternatives you've considered

I considered moving all the content to nvim-silicon subdir, create the old subdir silicon with a different init.lua file, that displays a deprecation notice, but then still loads the nvim-silicon files.

I am unsure, what the best way is within lazy to display things like that to the user. I saw that sometimes there are such notices in the Changelogs that lazy displays, but I could not find an info how to go about it. The events like LazyUpdate are probably not suitable for this, as those events are for the users of lazy and not for plugin authors...

If you have a pointer to best practices, I would highly appreciate it. If you don't have time for questions like this, I fully understand, then please close the issue. I just thought, maybe more are running into this kind of thing...

Thanks in advance and apologies if this question is out of place...

Michael.

Additional context

No response

[michaelrommel]

Used a message amendment, will later switch to vim.deprecate() calls.