[mini.pick] Colorscheme picker with preview

[pkazmier]

I added a colorscheme picker to my configuration this morning and thought I'd share in case others were interested. If you preview a colorscheme, it will change your current colorscheme to the one you are previewing. If you cancel the picker, it will revert back to the colorscheme you had before you entered the picker.

Screen.Recording.2024-06-08.at.10.24.59.AM.mov

To track state of the original picker, I added the ability to have custom pre- and post-hooks for individual pickers:

-- Picker pre- and post-hooks ===============================================

-- Keys should be a picker source.name. Value is a callback function that
-- accepts same arguments as User autocommand callback.
local hooks = {
  pre_hooks = {},
  post_hooks = {},
}

vim.api.nvim_create_autocmd({ "User" }, {
  pattern = "MiniPickStart",
  group = vim.api.nvim_create_augroup("minipick-pre-hooks", { clear = true }),
  desc = "Invoke pre_hook for specific picker based on source.name.",
  callback = function(...)
    local opts = MiniPick.get_picker_opts() or {}
    local pre_hook = hooks.pre_hooks[opts.source.name] or function(...) end
    pre_hook(...)
  end,
})

vim.api.nvim_create_autocmd({ "User" }, {
  pattern = "MiniPickStop",
  group = vim.api.nvim_create_augroup("minipick-post-hooks", { clear = true }),
  desc = "Invoke post_hook for specific picker based on source.name.",
  callback = function(...)
    local opts = MiniPick.get_picker_opts() or {}
    local post_hook = hooks.post_hooks[opts.source.name] or function(...) end
    post_hook(...)
  end,
})

With that in place, here is the definition of my colorscheme picker:

-- Colorscheme picker =======================================================

local selected_colorscheme -- Currently selected or original colorscheme

hooks.pre_hooks.Colorschemes = function()
  selected_colorscheme = vim.g.colors_name
end

hooks.post_hooks.Colorschemes = function()
  vim.cmd("colorscheme " .. selected_colorscheme)
end

MiniPick.registry.colorschemes = function()
  local colorschemes = vim.fn.getcompletion("", "color")
  return MiniPick.start({
    source = {
      name = "Colorschemes",
      items = colorschemes,
      choose = function(item)
        selected_colorscheme = item
      end,
      preview = function(buf_id, item)
        vim.cmd("colorscheme " .. item)
        vim.api.nvim_buf_set_lines(buf_id, 0, -1, false, { item })
      end,
    },
  })
end

[echasnovski]

Very nice! I think there were plans of including something like this in 'mini.extra'. Probably decided that it is fairly trivial to implement and left to the user.

I'd also think about applying color scheme not only inside preview, but also after choosing.

[pkazmier]

I'd also think about applying color scheme not only inside preview, but also after choosing.

It does apply if you choose it.

I don’t explicitly run the colorscheme command in the choose function because it would revert to the original colorscheme that was saved in the pre hook upon exit. The choose function simply sets the name of the selected item and the post hook is where the colorscheme command actually runs. This is how I’m able to revert to the user’s original scheme if they cancel.

[pkazmier]

Very nice! I think there were plans of including something like this in 'mini.extra'. Probably decided that it is fairly trivial to implement and left to the user.

Like you said, it was trivial to add the colorscheme picker and I’ve had that in my config for a while now. But it was not so trivial, at least for me, to figure out how to get preview working—especially if the user cancelled the picker. So, this morning, that’s how I landed up with the ability to add pre and post hooks for any picker, which I thought was pretty cool.

[echasnovski]

I don’t explicitly run the colorscheme command in the choose function because it would revert to the original colorscheme that was saved in the pre hook upon exit. The choose function simply sets the name of the selected item and the post hook is where the colorscheme command actually runs. This is how I’m able to revert to the user’s original scheme if they cancel.

Yeah, my bad. Didn't pay close attention to the content of the hooks. Overall makes sense.

[abeldekat]

Nice! I also use this idea. I did have to set the colorscheme like so:

  local on_stop = function()
    vim.schedule(function() -- must use schedule, otherwise eyeliner stops displaying
      vim.cmd.colorscheme(selected_colorscheme)
    end)
  end