🧭 Telescope Lazy Plugins

---@class TelescopeLazyPluginsUserConfig
---@field lazy_config? string Path to the file containing the lazy opts and setup() call.
---@field mappings? table Keymaps attached to the picker. See `:h telescope.mappings`.
---@field name_only? boolean Match only the `repo_name`, false to match the full `account/repo_name`.
---@field picker_opts? table Layout options passed into Telescope. Check `:h telescope.layout`.
---@field show_disabled? boolean Also show disabled plugins from the Lazy spec.
---@field auto_rescan? boolean Automatic rescan and rebuild the spec list if Lazy detects a change in the config.
---@field custom_entries? (LazyPluginsCustomEntry|LazyPluginsData)[] Table to pass custom entries to the picker.
---@field live_grep? table Options to pass into the `live_grep` telescope builtin picker.
---@field ignore_imports? string[]|table<string, boolean> Array of imports to ignore.
---@field actions? LazyPluginsConfigActions Actions options.

---@class LazyPluginsConfigActions
---@field opts_viewer? LazyPluginsActionOptsViewer

---@alias LazyPluginsDataField
--- | "name" Name of the plugin showed in the picker
--- | "full_name" Full name of the plugin repository (account/repo)
--- | "filepath" Full file path to the plugin lua configuration
--- | "line" Line number of the plugin definition in the lua file
--- | "repo_url" Url to the repo
--- | "repo_dir" Path to the local repository clone
--- | "file" Path to the config filename showed in the picker

---@alias LazyPluginsConfigViewer
--- | "float" Default. Open the plugin config in a float window.
--- | "tab" Open the plugin config in a new tab.

Lazy loader utility function:

local load_extension_after_telescope_is_loaded = function(extension_name)
  local lazy_cfg = require("lazy.core.config").plugins
  if lazy_cfg["telescope.nvim"] and lazy_cfg["telescope.nvim"]._.loaded then
    -- Since Telescope is loaded, just load the extension:
    require("telescope").load_extension(extension_name)
  else
    -- If Telescope is not loaded, create an autocmd that will load the
    -- extension after Telescope is loaded.
    vim.api.nvim_create_autocmd("User", {
      pattern = "LazyLoad",
      callback = function(event)
        if event.data == "telescope.nvim" then
          require("telescope").load_extension(extension_name)
          return true
        end
      end,
    })
  end
end

Usage:

return {
  {
    "nvim-telescope/telescope.nvim",
    cmd = "Telescope",
    dependencies = {
      { "nvim-lua/plenary.nvim" },
      {
        "polirritmico/telescope-lazy-plugins.nvim",
        init = function()
          load_extension_after_telescope_is_loaded("lazy_plugins")
        end,
      },
    },
    keys = {
      {"<leader>cp", "<Cmd>Telescope lazy_plugins<CR>", desc = "Telescope: Plugins configurations"},
    },
    -- Add the plugin configuration through the Telescope extensions options:
    opts = {
      extensions = {
        ---@module "telescope._extensions.lazy_plugins"
        ---@type TelescopeLazyPluginsUserConfig
        lazy_plugins = {
          show_disabled = true,
          lazy_config = vim.fn.stdpath("config") .. "/lua/config/lazy.lua", -- path to the file containing the lazy opts and setup() call.
          -- This is not needed. It is just an example of how you can customize the picker layout. Check `:h telescope.layout`.
          picker_opts = {
            layout_strategy = "vertical",
            layout_config = {
              vertical = { preview_cutoff = 15, preview_height = 0.5 },
            },
          },
          -- This is not needed. It is just an example of how you can add custom entries.
          custom_entries = {
            {
              name = "custom-entry-example",
              filepath = vim.fn.stdpath("config") .. "/lua/config/mappings.lua",
              repo_url = "https://www.lua.org/manual/5.2/",
              line = 23, -- Open the file with the cursor in this line
            },
          },
        },
      },
    },
  },
  -- etc.
}

-- Content of file: ~/.conf/nvim/init.lua
local opts = {
  -- Lazy configuration options
}
require("lazy").setup({
  -- full list of plugins and configs like this:
  "username/a_plugin",
  opts = {
    configurations = "custom values",
  },
  -- etc.
  {
    "nvim-telescope/telescope.nvim",
    dependencies = {
      { "nvim-lua/plenary.nvim" },
      { "polirritmico/telescope-lazy-plugins.nvim" },
    },
    opts = {
      extensions = {
        ---@module "telescope._extensions.lazy_plugins"
        ---@type TelescopeLazyPluginsUserConfig
        lazy_plugins = {
          -- Set the path of this file (~/.config/nvim/init.lua) into the `lazy_config` field:
          lazy_config = vim.fn.stdpath("config") .. "/init.lua"
        },
      },
    },
  },
}, opts)

Helper Functions:

• append_to_telescope_history:

Append the search to the Telescope history, allowing it to be reopened with :Telescope resume.

• custom_action:

A wrapper function to use custom actions. This function get and validates the selected entry field, executes the passed custom_function in a protected call and returns its output.

This example shows a message that displays the repository local clone path of the selected plugin entry.

Use custom_action to access the selected entry and execute a custom function:

--- The example function
---@param bufnr integer passed by the telescope mapping execution call
---@param entry LazyPluginsData passed inside `custom_action`
---@param custom_args {foo: string} If needed custom_args could be added in a table
local function demo_custom_function(bufnr, entry, custom_args)
  -- (require telescope inside the function call to not trigger a lazy load when
  -- parsing the config)
  local lp_actions = require("telescope").extensions.lazy_plugins.actions

  local arguments = custom_args.foo -- access values from the custom_args
  local repository_dir = entry.repo_dir -- access values from the selected picker entry
  local message = string.format("%s%s", arguments, repository_dir)
  vim.notify(message)

  -- Use the provided helper builtin functions:
  lp_actions.append_to_telescope_history(bufnr) -- Used by `:Telescope resume` and others.
  lp_actions.close(bufnr)
end
-- etc.

Then add it to a map action:

--- Inside the lazy_plugins config
lazy_plugins = {
  mappings = {
    ["i"] = {
      ["<C-g>d"] = function(prompt_bufnr)
        local args = { foo = "Plugin path from the selected entry.repo_dir: " }
        require("telescope").extensions.lazy_plugins.actions.custom_action(
          prompt_bufnr,
          "repo_dir", -- This is used to validate the entry. Could be any field of LazyPluginsData (name, full_name, filepath, line, repo_url or repo_dir).
          demo_custom_function,
          args
        )
      end,
    },
  },
},