[picker] Edit cliphist item before copying

[drowning-cat]

Related

• Edit clipboard in Nvim neovim/neovim#38256

Description

Warning

In most cases, you don't need this, since you can cycle to the preview window with <M-w> and copy the required part directly.

It can still be useful if you want to modify the clipboard content before copying, for example to remove unnecessary spaces.

Anyway, better to have this instead of an error on <S-CR>.

Code

1. :lua Snacks.picker.cliphist()
2. Press `<S-CR>` on the item.
3. Edit the scratch buffer.
4. Press `<CR>` to yank.

---@module 'snacks'

return {
  "folke/snacks.nvim",
  lazy = false,
  keys = {
    -- stylua: ignore
    { "<Leader>s<C-h>", function() Snacks.picker.cliphist() end, desc = "Cliphist" },
  },
  ---@type snacks.Config
  opts = {
    picker = {
      sources = {
        cliphist = {
          win = {
            input = {
              keys = {
                ["<S-CR>"] = { "cliphist_edit", mode = { "i", "n" } },
              },
            },
          },
          actions = {
            cliphist_edit = function(picker, item, action)
              local reg = action.reg or vim.v.register
              Snacks.scratch.open({
                icon = "💾",
                name = "Clipboard",
                filekey = { id = "Cliphist", branch = false, count = false, cwd = false },
                ft = "",
                win = {
                  on_close = function(win)
                    vim.bo[win.buf].modified = false
                  end,
                  on_win = function()
                    vim.cmd.stopinsert()
                    vim.cmd.norm("_l")
                  end,
                  on_buf = function(win)
                    local lines = vim.split(item.data, "\n")
                    vim.api.nvim_buf_set_lines(win.buf, 0, -1, true, lines)
                  end,
                  keys = {
                    ["confirm"] = {
                      "<CR>",
                      function(win)
                        local mode = vim.api.nvim_get_mode().mode
                        if mode:match("[Vv\22]") then
                          vim.cmd("silent normal! " .. '"' .. reg .. "y")
                        else
                          vim.cmd("silent %yank " .. reg)
                        end
                        local copied = vim.fn.getreg(reg)
                        Snacks.notify(
                          ("Yanked to register `%s`:\n```\n%s\n```"):format(reg, copied),
                          { title = "Snacks Picker" }
                        )
                        picker:close()
                        win:close()
                      end,
                      desc = 'Yank to "' .. reg,
                      mode = { "n", "x" },
                    },
                  },
                },
              })
            end,
          },
        },
      },
    },
  },
}