Neat-looking code action menu

[Andrew15-5]

Hello, I really want to know how did you set up that small code action menu:

I was able to do something similar with actions-preview.nvim:

lazy.nvim

  {
    "aznhe21/actions-preview.nvim",
    dependencies = "MunifTanjim/nui.nvim",
    keys = {
      {
        "gf",
        function()
          require("actions-preview").code_actions()
        end,
        mode = { "v", "n" },
      },
    },
    opts = {
      backend = {
        "nui",
        "telescope",
      },
      nui = {
        layout = {
          position = {
            row = 0,
            col = 0,
          },
          size = {
            width = 28,
            height = 11,
          },
          relative = "cursor",
        },
        preview = {
          size = "30%",
        },
        select = {
          size = "70%",
        },
      },
    },
  },

But this will break any other form of code actions. I also was wondering if that menu supports quick selection via number keys (without Enter or anything like that).

The only other option is to manually make a custom window just for this file and use normal general menu elsewhere.

[saecki]

It's a little lua module I've written which can be used as a vim.ui.select replacement. It only relies upon is a custom border in my config, but you could just change this one line and this highlight to something else.

And yes it does support quick selection via the number keys. Feel free to copy paste if you like it :)

[Andrew15-5]

So it is a custom window after all... I would assume you can do the same thing with a few lines of code with some library.

I will check it out later. Can't wait.

[Andrew15-5]

Niice. Thanks. I added it to the end of a custom.configs.crates module. So it only appears for Cargo.toml.

snippet

local M = {}

local namespace = vim.api.nvim_create_namespace "user.util.select"

local calculate_popup_width = function(entries)
  local result = 0

  for _, entry in ipairs(entries) do
    local width = vim.fn.strdisplaywidth(entry)
    if width > result then
      result = #entry
    end
  end

  result = result + 2

  local num_entries = #entries
  while num_entries >= 10 do
    num_entries = num_entries / 10
    result = result + 1
  end

  return result
end

local format_entries = function(entries, formatter)
  local format_item = formatter or tostring

  local results = {}

  for _, entry in pairs(entries) do
    table.insert(results, string.format("%s", format_item(entry)))
  end

  return results
end

local function hide()
  if M.win and vim.api.nvim_win_is_valid(M.win) then
    vim.api.nvim_win_close(M.win, false)
  end
  M.win = nil

  if M.buf and vim.api.nvim_buf_is_valid(M.buf) then
    vim.api.nvim_buf_delete(M.buf, {})
  end
  M.buf = nil
end

local function highlight()
  local row = vim.api.nvim_win_get_cursor(M.win)[1] - 1
  vim.api.nvim_buf_clear_namespace(M.buf, namespace, 0, -1)
  vim.api.nvim_buf_add_highlight(M.buf, namespace, "healthSuccess", row, 0, -1)
end

-- 1 based index
function M.confirm(index)
  if index == nil then
    index = vim.api.nvim_win_get_cursor(M.win)[1]
  end
  hide()
  if M.on_choice and M.items and M.items[index] then
    M.on_choice(M.items[index], index)
  end
end

function M.cancel()
  hide()
  if M.on_choice then
    M.on_choice()
  end
end

function M.select(items, opts, on_choice)
  assert(items ~= nil and not vim.tbl_isempty(items), "No entries available.")

  -- close still open window
  hide()

  M.items = items
  M.on_choice = on_choice

  local formatted_items = format_entries(items, opts.format_item)
  local width = calculate_popup_width(formatted_items)

  -- create buf
  M.buf = vim.api.nvim_create_buf(false, true)
  vim.api.nvim_buf_set_lines(M.buf, 0, 1, false, formatted_items)
  -- vim.api.nvim_set_option_value("filetype", "markdown", { buf = M.buf })
  vim.api.nvim_set_option_value("modifiable", false, { buf = M.buf })

  -- get word start
  local old_pos = vim.api.nvim_win_get_cursor(0)
  vim.fn.search(vim.fn.expand "<cword>", "bc")
  local new_pos = vim.api.nvim_win_get_cursor(0)
  vim.api.nvim_win_set_cursor(0, { old_pos[1], old_pos[2] })
  local col = 0
  if new_pos[1] == old_pos[1] then
    col = new_pos[2] - old_pos[2]
  end

  local chars = {
    border_n = "─",
    border_s = "─",
    border_e = "│",
    border_w = "│",

    corner_nw = "╭",
    corner_sw = "╰",
    corner_ne = "╮",
    corner_se = "╯",
  }

  -- create win
  local win_opts = {
    relative = "cursor",
    col = col - 3,
    row = 1,
    width = width,
    height = #items,
    style = "minimal",
    border = {
      chars.corner_nw,
      chars.border_n,
      chars.corner_ne,
      chars.border_e,
      chars.corner_se,
      chars.border_s,
      chars.corner_sw,
      chars.border_w,
    },
  }
  M.win = vim.api.nvim_open_win(M.buf, false, win_opts)

  -- key mappings
  vim.api.nvim_buf_set_keymap(M.buf, "n", "<cr>", "", {
    callback = function()
      M.confirm()
    end,
    noremap = true,
    silent = true,
  })
  for i = 1, math.min(#formatted_items, 9) do
    vim.api.nvim_buf_set_keymap(M.buf, "n", tostring(i), "", {
      callback = function()
        M.confirm(i)
      end,
      noremap = true,
      silent = true,
    })
  end
  vim.api.nvim_buf_set_keymap(M.buf, "n", "<esc>", "", { callback = M.cancel, noremap = true, silent = true })
  vim.api.nvim_buf_set_keymap(M.buf, "n", "q", "", { callback = M.cancel, noremap = true, silent = true })

  -- highlight current line
  local group = vim.api.nvim_create_augroup("user.util.select", {})
  vim.api.nvim_create_autocmd({ "CursorMoved", "CursorMovedI" }, {
    group = group,
    buffer = M.buf,
    callback = highlight,
  })

  -- focus window
  vim.api.nvim_set_current_win(M.win)
  highlight()

  vim.opt_local.number = true
  if #formatted_items < 10 then
    vim.opt_local.numberwidth = 2
  else
    vim.opt_local.numberwidth = 3
  end
end

vim.ui.select = M.select

I also tried it with code-modifying actions and it does show (change) preview. Are you not interested in such previews at all? Or is this window popup is only for Cargo.toml for you as well?

I think I need to either update my code action keymap or make you handler more complex. I will go with the first one.

[saecki]

No I use this for all code actions. I don't really care about previews and other fancy stuff, so I kept this quite minimalistic.