[mini.pick] fff.nvim integration

[diego-velez]

Ever since fff.nvim came out, I've been wanting to use it, but I did not want to use their picker UI. Now, I managed to integrate their backend with mini.pick :)

Screenshot

Install fff.nvim

I use rustup to manage my rust toolchains, you could change the cmd to just cargo build --release if you don't use that. Also, I have a lot of vim.notify because I like to let myself know what is happening. You could remove that if you wanted to.

later(function()
  ---@param args { path: string, name: string, source: string }
  local function build_fff(args)
    local cmd = { 'rustup', 'run', 'nightly', 'cargo', 'build', '--release' }
    local opts = { cwd = args.path, text = true }

    vim.notify('Building ' .. args.name, vim.log.levels.INFO)
    vim.cmd.redraw()

    local out = vim.system(cmd, opts):wait()
    if out.code ~= 0 then
      vim.notify('Failed to build fff.nvim', vim.log.levels.ERROR)
      vim.notify(out.stderr, vim.log.levels.ERROR)
    else
      vim.notify(args.name .. ' Built', vim.log.levels.INFO)
    end
  end

  add {
    source = 'dmtrKovalenko/fff.nvim',
    hooks = {
      post_install = build_fff,
      post_checkout = build_fff,
    },
  }
end)

fff.nvim picker

Remember to source this after adding the fff.nvim plugin. You can run the picker from anywhere by using MiniPick.registry.fffiles().

---@class FFFItem
---@field name string
---@field path string
---@field relative_path string
---@field size number
---@field modified number
---@field total_frecency_score number
---@field modification_frecency_score number
---@field access_frecency_score number
---@field git_status string

---@class PickerItem
---@field text string
---@field path string
---@field score number

---@class FFFPickerState
---@field current_file_cache string
local state = {}

local ns_id = vim.api.nvim_create_namespace 'MiniPick FFFiles Picker'
vim.api.nvim_set_hl(0, 'FFFileScore', { fg = '#FFFF00' })

---@param query string|nil
---@return PickerItem[]
local function find(query)
  local file_picker = require 'fff.file_picker'

  query = query or ''
  ---@type FFFItem[]
  local fff_result = file_picker.search_files(query, 100, 4, state.current_file_cache, false)

  local items = {}
  for _, fff_item in ipairs(fff_result) do
    local item = {
      text = fff_item.relative_path,
      path = fff_item.path,
      score = fff_item.total_frecency_score,
    }
    table.insert(items, item)
  end

  return items
end

---@param items PickerItem[]
local function show(buf_id, items)
  local icon_data = {}

  -- Show items
  local items_to_show = {}
  for i, item in ipairs(items) do
    local icon, hl, _ = MiniIcons.get('file', item.text)
    icon_data[i] = { icon = icon, hl = hl }

    items_to_show[i] = string.format('%s %s %d', icon, item.text, item.score)
  end
  vim.api.nvim_buf_set_lines(buf_id, 0, -1, false, items_to_show)

  vim.api.nvim_buf_clear_namespace(buf_id, ns_id, 0, -1)

  local icon_extmark_opts = { hl_mode = 'combine', priority = 200 }
  for i, item in ipairs(items) do
    -- Highlight Icons
    icon_extmark_opts.hl_group = icon_data[i].hl
    icon_extmark_opts.end_row, icon_extmark_opts.end_col = i - 1, 1
    vim.api.nvim_buf_set_extmark(buf_id, ns_id, i - 1, 0, icon_extmark_opts)

    -- Highlight score
    local col = #items_to_show[i] - #tostring(item.score) - 3
    icon_extmark_opts.hl_group = 'FFFileScore'
    icon_extmark_opts.end_row, icon_extmark_opts.end_col = i - 1, #items_to_show[i]
    vim.api.nvim_buf_set_extmark(buf_id, ns_id, i - 1, col, icon_extmark_opts)
  end
end

local function run()
  -- Setup fff.nvim
  local file_picker = require 'fff.file_picker'
  if not file_picker.is_initialized() then
    local setup_success = file_picker.setup()
    if not setup_success then
      vim.notify('Could not setup fff.nvim', vim.log.levels.ERROR)
      return
    end
  end

  -- Cache current file to deprioritize in fff.nvim
  if not state.current_file_cache then
    local current_buf = vim.api.nvim_get_current_buf()
    if current_buf and vim.api.nvim_buf_is_valid(current_buf) then
      local current_file = vim.api.nvim_buf_get_name(current_buf)
      if current_file ~= '' and vim.fn.filereadable(current_file) == 1 then
        local relative_path = vim.fs.relpath(vim.uv.cwd(), current_file)
        state.current_file_cache = relative_path
      else
        state.current_file_cache = nil
      end
    end
  end

  -- Start picker
  MiniPick.start {
    source = {
      name = 'FFFiles',
      items = find,
      match = function(_, _, query)
        local items = find(table.concat(query))
        MiniPick.set_picker_items(items, { do_match = false })
      end,
      show = show,
    },
  }

  state.current_file_cache = nil -- Reset cache
end

MiniPick.registry.fffiles = run

vim.keymap.set('n', '<leader><space>', MiniPick.registry.fffiles)

PS

The end result should be the same UI as the default mini.pick file picker, except that it also has the frecency score for each file. You can also add Git status if you wanted too. The search_files function from fff.nvim returns a few things per file (as I documented with the FFFItem LuaDoc class) like size, modified time and git status.

[echasnovski]

Thanks for sharing!

I personally don't really like the (subjectively) over complicated approach to how 'fff.nvim' handles file picking, but guess it is a matter of taste :)

Nothing particularly wrong stood out to me after scanning code. One question though: why do use querytick = 0 in set_picker_opts?

[diego-velez]

I personally don't really like the (subjectively) over complicated approach to how 'fff.nvim' handles file picking, but guess it is a matter of taste :)

Yeah, I think that even though it definitely is way more complex compared to the way that mini.pick does things by default, I personally think it is worth it. It is resilient to typos, and it finds what I want better, especially in bigger codebases. I most certainly probably could do the same with default mini.pick if I learn to use the refine and glob workflow. But at least right now, I'd rather do this and just type what I want and have the first result be the file I'm looking for.

Nothing particularly wrong stood out to me after scanning code. One question though: why do use querytick = 0 in set_picker_opts?

I could've sworn that the picker didn't work without that, but it seems that it does now (I updated the code to reflect). If you may, could you clarify what querytick does for mini.pick?

[echasnovski]

Nothing particularly wrong stood out to me after scanning code. One question though: why do use querytick = 0 in set_picker_opts?

I could've sworn that the picker didn't work without that, but it seems that it does now (I updated the code to reflect). If you may, could you clarify what querytick does for mini.pick?

It increases every time query is updated (including picker start and stop). See this.