Show todo-comments in mini.pick

[diego-velez]

Hey all!

I've been replacing telescope for mini.pick recently, and I made a picker to show all todo comments. This is for folke's todo-comments plugin, since it has an extension for telescope and fzf-lua, but not for mini.pick, so I wrote one for it.

Check it out:

    MiniPick.registry.todo = function()
      local show_todo = function(buf_id, entries, query, opts)
        MiniPick.default_show(buf_id, entries, query, opts)

        -- Add highlighting to every line in the buffer
        for line, entry in ipairs(entries) do
          for _, hl in ipairs(entry.hl) do
            vim.api.nvim_buf_add_highlight(
              buf_id,
              ns_digit_prefix,
              hl[2],
              line - 1,
              hl[1][1],
              hl[1][2]
            )
          end
        end
      end
      require('todo-comments.search').search(function(results)
        local Config = require 'todo-comments.config'
        local Highlight = require 'todo-comments.highlight'

        for i, entry in ipairs(results) do
          -- By default, mini.pick uses the path item when an item is choosen to open it
          entry.path = entry.filename
          entry.filename = nil

          local relative_path = string.gsub(entry.path, vim.fn.getcwd() .. '/', '')
          local display = string.format('%s:%s:%s ', relative_path, entry.lnum, entry.col)
          local text = entry.text
          local start, finish, kw = Highlight.match(text)

          entry.hl = {}

          if start then
            kw = Config.keywords[kw] or kw
            local icon = Config.options.keywords[kw].icon or ' '
            display = icon .. ' ' .. display
            table.insert(entry.hl, { { 0, #icon + 1 }, 'TodoFg' .. kw })
            text = vim.trim(text:sub(start))

            table.insert(entry.hl, {
              { #display, #display + finish - start + 2 },
              'TodoBg' .. kw,
            })
            table.insert(entry.hl, {
              { #display + finish - start + 1, #display + finish + 1 + #text },
              'TodoFg' .. kw,
            })
            entry.text = display .. ' ' .. text
          end

          results[i] = entry
        end

        MiniPick.start { source = { name = 'Find Todo', show = show_todo, items = results } }
      end, nil)

   end

This is how it looks:

I basically took the code that folke had made for the telescope extension and made it work for mini.pick.

Any feedback is appreciated!! Enjoy!!

[echasnovski]

Thanks for sharing! Adding extra highlighting is a nice touch!

I'd personally recommend moving two function definitions outside of an actual MiniPick.registry entry. There is no need for them to be created every time the picker is used.

Also, adding nil as last argument in function call is redundant. But I'd say it is a matter of taste.