Migrating from Plugin.config to Plugin.opts

[Syphdias]

Hi, I use LazyVim for about two weeks now and mostly use default so far (they seem great so far!).
Every now and then I find something that seems cool and that I want to add to my config or something bothers me and I want to change something. But I think I am doing it wrong.

Checkhealth tells me:

- WARNING {neo-tree.nvim}: setting a table to Plugin.config is deprecated. Please use Plugin.opts instead
- WARNING {telescope.nvim}: setting a table to Plugin.config is deprecated. Please use Plugin.opts instead

I only want to expand on the defaults and only overwrite what I want to change.

My ~/.config/nvim/lua/plugins/neo-tree.lua

return {
  "nvim-neo-tree/neo-tree.nvim",

  -- opts = function(_, opts)
  -- ???
  -- end

  config = {
    window = {
      mappings = {
        ["l"] = "open",
        ["h"] = "close_node",
      },
    },
  },
}

My ~/.config/nvim/lua/plugins/telescope.lua

return {
  "nvim-telescope/telescope.nvim",
  dependencies = {
    {
      "nvim-telescope/telescope-fzf-native.nvim",
      build = "make",
      config = function()
        require("telescope").load_extension("fzf")
      end,
    },
  },

  config = {
    defaults = {
      mappings = {
        i = {
          ["<C-k>"] = require("telescope.actions").move_selection_previous,
          ["<C-j>"] = require("telescope.actions").move_selection_next,
          ["<C-q>"] = require("telescope.actions").send_selected_to_qflist + require("telescope.actions").open_qflist,
        },
      },
    },
  },

  -- -- does not work
  -- opts = function(_, opts)
  --   local telescope = require("telescope")
  --   opts.defaults.mappings.i = telescope.config.mappings.i(vim.tbl_extend(opts.defaults.mappings.i, {
  --     ["<C-k>"] = require("telescope.actions").move_selection_previous,
  --     ["<C-j>"] = require("telescope.actions").move_selection_next,
  --     ["<C-q>"] = require("telescope.actions").send_selected_to_qflist + require("telescope.actions").open_qflist,
  --   }))
  -- end,

  -- -- does not work
  -- mappings = {
  --   i = {
  --     ["<C-k>"] = require("telescope.actions").move_selection_previous,
  --     ["<C-j>"] = require("telescope.actions").move_selection_next,
  --     ["<C-q>"] = require("telescope.actions").send_selected_to_qflist + require("telescope.actions").open_qflist,
  --   },
  -- },

  -- -- does not work
  -- config = function(_, config)
  --   local actions = require("telescope.actions")

  --   config.defaults.mappings.i = vim.tbl_extend("force", config.defaults.mappings.i, {
  --     ["<C-k>"] = actions.move_selection_previous,
  --     ["<C-j>"] = actions.move_selection_next,
  --     ["<C-q>"] = actions.send_selected_to_qflist + actions.open_qflist,
  --   })
  -- end,
}

I tried a few things for telescope and played around with opts = function(_, opts) end similar to https://www.lazyvim.org/configuration/plugins#%EF%B8%8F-customizing-plugin-specs but I could not get it to work.

Any advice how it is done properly? I think I am still lacking some understanding how lua works.

PS: What is the difference between keys and mappings?

[folke]

As the message says, config as a table is deprecated. Use opts instead for this:

return {
  "nvim-neo-tree/neo-tree.nvim",
  opts = {
    window = {
      mappings = {
        ["l"] = "open",
        ["h"] = "close_node",
      },
    },
  },
}

The same for telescope.

However, you also need to make sure to use proper closures, otherwise you're loading telescope in the spec itself. Which is not somhing you want.

["<C-k>"] = function(...)
  return require("telescope.actions").move_selection_previous(...)
end

keys is something that lazy supports. mappings is a telescope option, unrelated to lazy

[Syphdias]

🤦 Okay, easier than I expected. Thank you!

Also, thank you for the closure hint!

For completeness sake. Here are the two files as they are now:

~/.config/nvim/lua/plugins/neo-tree.lua

return {
  "nvim-neo-tree/neo-tree.nvim",

  opts = {
    window = {
      mappings = {
        ["l"] = "open",
        ["h"] = "close_node",
      },
    },
  },

~/.config/nvim/lua/plugins/telescope.lua

return {
  "nvim-telescope/telescope.nvim",
  dependencies = {
    {
      "nvim-telescope/telescope-fzf-native.nvim",
      build = "make",
      config = function()
        require("telescope").load_extension("fzf")
      end,
    },
  },

  opts = {
    defaults = {
      mappings = {
        i = {
          ["<C-k>"] = function(...)
            return require("telescope.actions").move_selection_previous(...)
          end,
          ["<C-j>"] = function(...)
            return require("telescope.actions").move_selection_next(...)
          end,
          ["<C-q>"] = function(...)
            return require("telescope.actions").send_selected_to_qflist(...)
              + require("telescope.actions").open_qflist(...)
          end,
        },
      },
    },
  },
}

PS: Thank you for making LazyVim!

[edu-vi]

this changes looks to be very good defaults? or there is another way to achieve this without moving the hand from middle row