Lazy Loading - Undotree

[Barnoux]

Problem Statement

The undotree plugin doesn't loads during startup. Or, the plugin has a "keys" key.

Workaround
I set lazy = false in the plugin's configuration. This option ensures that the plugin is ready for use immediately after the editor starts.

My configuration of undotree:

{
    "mbbill/undotree",
    keys = {
      vim.keymap.set("n", "<leader>u", vim.cmd.UndotreeToggle)
    },
  }

Does someone can help me with this ?

[abeldekat]

Hello @Barnoux,

The default value for Config.options.defaults.lazy is false.
Adding the keys property to the spec changes the lazy property of the plugin to true, see plugin.lua

However, your keys definition is not correct. See lazy key mappings.

If you do not need to lazy-load using the keys property of the Plugin Spec, you can define the key in the init function:

{
    "mbbill/undotree",
    init = function()
      vim.keymap.set("n", "<leader>u", vim.cmd.UndotreeToggle)
    end,
}

Best regards!

[Barnoux]

Well well well! Always Read The Friendly Manual i guess...
Thank you @abeldekat 😃

[abeldekat]

You're welcome!
I forgot to add the alternative:

   {
    "mbbill/undotree",
    lazy = false, -- needs to be explicitly set, because of the keys property
    keys = {
      {
        "<leader>u",
        vim.cmd.UndotreeToggle,
        desc = "Toggle undotree",
      },
    },
  }

The benefit: I you change the loading into lazy=true, lazy.nvim's key is already defined.