bug: The option dev.path no longer works with a function

[tigion]

Did you check docs and existing issues?

• I have read all the lazy.nvim docs
• I have updated the plugin to the latest version before submitting this issue
• I have searched the existing issues of lazy.nvim
• I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.10.1

Operating system/version

macOS 14.6.1

Describe the bug

The option for the path to local plugins no longer works with a function.

A simple example:

  dev = {
    -- path = get_local_dev_path, -- Don't work
    -- path = function() return '~/projects/neovim' end, -- Don't work
    path = '~/projects/neovim', -- Works
  },

I have a function that searches in different directories and returns the first hit, but this no longer works:

---Returns the first path from a set of paths in which
---the local dev version of the plugin is located.
---@param plugin LazyPlugin
---@return string
local function get_local_dev_path(plugin)
  local search_paths = {
    '~/projects/neovim', -- default path, if not found in other paths
    '~/projects/neovim/fork',
    '~/projects/private/neovim',
    '~/projects/private/neovim/fork',
  }
  for _, path in ipairs(search_paths) do
    if vim.fn.isdirectory(vim.fn.expand(path) .. '/' .. plugin.name) == 1 then return path end
  end
  return search_paths[1]
end

[tigion]

I did some more testing. If I use the function directly, it works:

...

---@param plugin LazyPlugin
---@return string
local function get_path1(plugin)
  return '~/projects/neovim'
end

---@return string
local function get_path2()
  return '~/projects/neovim'
end

---@type LazyConfig
local opts = {
  dev = {
    path = get_path1, -- Don't work (path get a function)
    path = get_path2(), -- Works (path get a string)
    path = '~/projects/neovim', -- Works (path get a string)
  },
}

require('lazy').setup(spec, opts)

[max397574]

well the get_path2() isn't actually a function but a string. The function gets evaluated when setting the value and lazy doesn't even know nor care where it came from

[tigion]

Yes, it was a step in my debugging process. :)

I think I found it:

• If dev.path is a string, Lazy.nvim itself appends the plugin name to the path.
• If dev.path is a function, Lazy.nvim don't add the plugin name to the path and so the path is invalid.

---@param plugin LazyPlugin
---@return string
local function get_path(plugin)
  return '~/projects/neovim/' .. plugin.name -- <-- I now must add the plugin name here
end

---@type LazyConfig
local opts = {
  dev = {
    path = get_path, -- Now works (path get a function)
    path = '~/projects/neovim', -- Works (path get a string)
  },
}

• Line in meta.lua:

  • lazy.nvim/lua/lazy/core/meta.lua

    Line 226 in 077102c

    local dev_dir = type(Config.options.dev.path) == "string" and Config.options.dev.path .. "/" .. plugin.name

  • lazy.nvim/lua/lazy/core/meta.lua

    Line 227 in 077102c

    or Util.norm(Config.options.dev.path(plugin))

[max397574]

are you sure this worked in the past?
because by looking at the commit history it seems like this didn't change recently

perhaps you could open a pull request to clarify the docs on this and close this issue

[tigion]

are you sure this worked in the past?

That's a good question. I should have asked myself that earlier. 🫣

After researching the history of the repositories, I think it has always been like this and the description is simply misleading.

A pull request to clarify the docs is a good Idea.