[harpoon2] when custom key is specified, persistent not working correctly

[rndev-io]

WARNING
If this is about Harpoon1, the issue will be closed. All support and everything of harpoon1 will be frozen on master until 4/20 or 6/9 and then harpoon2 will become master

Please use harpoon2 for branch

My harpoon setup:

harpoon:setup({
    settings = {
        save_on_toggle = true,
        sync_on_ui_close = true,
        key = function()
            local key = vim.fn.getcwd()
            local current_branch = utils.get_current_branch()
            if current_branch ~= nil then
                key = string.format("%s#%s", key, current_branch)
            end
            return key
        end
    }
})

I add and remove file to harpoon, but when i close and open nvim again, my harpoon list is empty.

[ThePrimeagen]

let me try this out and i'll see if we can get a quick fix for this

seems surprising!

[gustavo-nakabayashi]

same bug here

This is my setup:

harpoon:setup({
    settings = {
      save_on_toggle = true,
      sync_on_ui_close = false,
      key = function()
        local handle = io.popen("git rev-parse --abbrev-ref HEAD 2> /dev/null")
        local branch_name = handle:read("*a")
        handle:close()
        branch_name = string.gsub(branch_name, "\n", "")
        if branch_name == nil or branch_name == '' then
          return vim.loop.cwd()
        else
          return branch_name .. vim.loop.cwd()
        end
      end,
    },
  })

[akyrey]

Same problem with a similar configuration (different lists based on branch).
It seems like the list is correctly saved but when opening a new instance of nvim the list isn't read and it's always displayed empty

[rndev-io]

Problem with the_harpoon singleton. When module imported, singleton created, and using default key for data storage (vim.loop.cwd). Then when harpoon:setup called, default config updated, but data storage stay with default key

[dajabe]

Having this issue as well with a similar config, hoping that #557 can be merged soon

[g-pavlik]

I have the same issue, from what I see in the thread – this does not seem to be the issue of any particular key function implementation, but a bug in harpoon2?

Here's my approach: (Added logging to check the sanity, and the returned key appears to be correct and repeatable for the branch)

local function debug_print(...)
  print(vim.inspect(...))
end

harpoon:setup({
  settings = {
    key = function()
      debug_print("key")
      local pipe = io.popen("git branch --show-current")
      if pipe then
        debug_print("pipe")
        local c = pipe:read("*l"):match("^%s*(.-)%s*$")
        debug_print(c)
        pipe:close()
        return c
      end
      return "default list"
    end,
  },
})

Edit: Found a workaround. No need to set settings = { key what you can do instead is define your own way to figure out a key, e.g. current branch:

local function git_branch()
  debug_print("key")
  local pipe = io.popen("git branch --show-current")
  if pipe then
    debug_print("pipe")
    local c = pipe:read("*l"):match("^%s*(.-)%s*$")
    debug_print(c)
    pipe:close()
    return c
  end
  return "default list"
end

and use it in each keymap declaration, like this

{
    "<M-j>",
    function()
      harpoon:list(git_branch()):next()
    end,
    desc = "Select next",
  },