Enhance Mini.pick: Custom Highlighting Post-Show Hook

Hey guys! 👋 I'm super excited to dive into a cool feature for mini.pick! I've been tinkering around and realized there's a neat way to make it even more flexible. Specifically, I want to add a post-show hook to the default_show function. This would let us customize how things are highlighted, opening up some awesome possibilities. Ready to check it out?

The Idea: A Post-Show Hook for mini.pick

So, the main goal is to introduce a post_show hook within the default_show function of mini.pick. This hook would run after the items are displayed, giving us a chance to modify their appearance. This is a game-changer because it allows for super-specific customizations without messing with the core picking logic. Imagine being able to add all sorts of extra info or styling to each item. That's the power we're talking about! The beauty of this is that it doesn't just benefit me, it benefits everyone who uses mini.pick. I can imagine other people having a lot of different uses for this, as it allows for a lot of flexibility and modification.

Here’s how I envision the implementation:

MiniPick.default_show = function(buf_id, items, query, opts)
  --- ...
  if type(opts.hook) == 'table' and type(opts.hook.post_show) == 'function' then opts.hook.post_show(prefix_data) end
end

Essentially, we're checking if opts.hook is a table and if it contains a post_show function. If it does, we run that function, passing in the prefix_data. This gives the user a clean and simple way to tap into the display process. It's all about making mini.pick adaptable and powerful, allowing the user to make the function their own. This kind of flexibility is a core tenet of the nvim-mini philosophy: provide powerful tools, and allow users to tailor them to their specific needs. I think this fits in perfectly with that. This post-show hook is designed to be a flexible and non-intrusive way to add extra functionality to the mini.pick experience.

My Use Case: Adding Git Status Tags

My specific use-case (and the reason I started exploring this idea) is to append git status tags to each picker item. For example, if a file has been modified in git, I want to show a little tag next to it to indicate that. It really helps me at a glance, and makes my workflow much more efficient! I can then immediately tell which files need to be committed. This level of visual feedback is incredibly useful when navigating through files. This customization is a perfect fit for a post-show hook because it lets us modify the displayed items after they've been generated by mini.pick. I can modify each item in the picker with the appropriate git status tag. It's a clean separation of concerns, keeping the core picking logic uncluttered.

Check out this screenshot to see what it looks like in action:

As you can see, I've got little tags indicating the git status of each file. It really makes things pop, and is a great visual cue. I think it would be a very useful addition, which is why I want to make it happen!

How It Works (Code Snippet)

Here's how I'm using the hook in my config:

mini_pick.default_show(buf_id, items, query, {
    show_icons = true,
    hook = {
        post_show = function(prefix_data)
            local ns_id = vim.api.nvim_create_namespace("")
            for i, item in ipairs(items) do
                local row = item - 1
                local prefix_len = nil
                local col = nil
                local col_end = 
                local highlight_group = nil

                --- Logic

                vim.api.nvim_buf_set_extmark(
                    buf_id,
                    ns_id,
                    row,
                    col,
                    {
                        hl_mode = "replace",
                        priority = 200,
                        hl_group = highlight_group,
                        end_row = row,
                        end_col = col_end,
                    }
                )
            end
        end,
    },
end)

Essentially, the post_show function iterates through each item and uses vim.api.nvim_buf_set_extmark to add highlighting based on git status. It creates a namespace, calculates the correct column positions, and then sets the highlighting. The hl_group is where the magic happens; this would be the name of a highlight group defined in your colorscheme. I've found this is a clean and efficient way to achieve the desired effect. The key here is that the hook lets us customize the display without altering the core functionality of mini.pick. This means we can add all sorts of cool visual enhancements without affecting how the items are selected and filtered. I love the separation of concerns.

Why This Matters and Why You Should Care!

This enhancement isn't just about adding git status tags. It's about opening up a whole new level of customization for mini.pick. Imagine the possibilities:

• Custom Icons: Add custom icons based on file types, statuses, or any other criteria.
• Dynamic Highlighting: Change the highlight of items based on their content, status, or any other dynamic data.
• Advanced Information: Display extra information about each item, such as file sizes, modification dates, or any other metadata you can grab.
• Integration with other plugins: Create even more seamless integration with other plugins. Think of the possibilities!

The post_show hook gives you the tools to make mini.pick fit your specific workflow, whatever that may be. It's about empowering users to adapt and extend the functionality of the tools they use. This is core to the nvim-mini philosophy, and it's something I'm passionate about. It is the perfect opportunity to customize your experience, so you can tailor the editor to your individual needs.

The Details: Opening a PR

I'm ready to open a pull request (PR) if you think this is a good idea. I've already tested it, and it works great. My code is ready to go! I've also read the contributing guidelines and the code of conduct. I'm all about following the rules and making sure everything fits in seamlessly. I'm excited about the prospect of contributing this feature, and I'm looking forward to working with the community to make mini.pick even better. This would be a great chance for me to learn more, and I'm very happy to take on the challenge!

I'm totally open to feedback and suggestions. My goal is to make sure this enhancement aligns perfectly with the project's vision and standards. If you have any questions, comments, or suggestions, please let me know. I want to make sure the PR is the best it can be.

In Conclusion: Ready to Enhance!

Adding a post_show hook to mini.pick's default_show function opens up exciting possibilities for customization and enhancements. It allows users to modify the appearance of picker items, making them more informative and tailored to individual workflows. This simple addition has the potential to supercharge mini.pick, enabling users to create a highly personalized and efficient editing experience. I'm ready to open that PR! What do you guys think? Let me know, and thanks for taking the time to consider this!