fzf integration as an alternative to telescope - closes #701

CONTRIBUTING.md

@@ -86,11 +86,10 @@ Please read the docs over there if you are every working on debugging related
 stuff with as they are pretty thorough and insightful. Mathias does a great job
 at making sure his stuff is stable and documented.
 
-The metals commands are also available as a
-[telescope](https://github.com/nvim-telescope/telescope.nvim) extension. The
-code for this is pretty self contained and can be found in
-`https://github.com/scalameta/nvim-metals/tree/main/lua/telescope/_extensions`.
-
+The metals commands are also available as
+[extensions](https://github.com/scalameta/nvim-metals/tree/main/lua/telescope/_extensions)
+for [telescope](https://github.com/nvim-telescope/telescope.nvim)
+and [fzf-lua](https://github.com/ibhagwan/fzf-lua).
 
 ## Logging
 

README.md

@@ -94,7 +94,7 @@ To see the full details on the available configurations, checkout out `:help
 metals-integrations`. The currently available integrations are:
 - [nvim-dap](https://github.com/mfussenegger/nvim-dap)
 - [Telescope](https://github.com/nvim-telescope/telescope.nvim)
-
+- [fzf-lua](https://github.com/ibhagwan/fzf-lua)
 
 [^no-lspconfig]: If you're familiar with nvim and LSP you'll probably know of
   [`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig) which also has a

doc/metals.txt

@@ -865,11 +865,11 @@ commands()                                                           *commands()
                            utilizing |vim.ui.select()|. If you're a telescope
                            user you can choose to use this with something like
                            https://github.com/stevearc/dressing.nvim or feel
-                           free to use the built-in telescope extension
-                           |metals-telescope| which just displays things a bit
-                           better since we have more control over using
-                           |vim.ui.select()|. If you're not a telescope user,
-                           then you'll want to use this.
+                           free to use the built-in extensions
+                           |metals-telescope| or |metals-fzf-lua| which just displays 
+                           things a bit better since we have more control over using
+                           |vim.ui.select()|. If you're not a telescope or
+                           fzf-lua user, then you'll want to use this.
 
                                                                *compile_cancel()*
 compile_cancel()           Use to execute a |metals.compile-cancel| command.
@@ -1370,7 +1370,7 @@ https://github.com/nvim-telescope/telescope.nvim which allows you to easily
 choose any of the |metals-commands|. You can trigger the picker by using the
 following function in a mapping: >
 
-  lua require("telescope").extensions.metals.commands()
+  :lua require("telescope").extensions.metals.commands()
 <
 
 If this is the only way you'll trigger the picker, then there is no need to
@@ -1387,8 +1387,17 @@ longer be lazy loaded. >
   require("telescope").extensions.metals.commands()
 
 <
+                                                              *metals-fzf-lua*
 
-NOTE: If you'd rather utilize |vim.ui.select| for this a more generate
+Metals provides a custom picker from
+https://github.com/ibhagwan/fzf-lua which allows you to easily
+choose any of the |metals-commands|. You can trigger the picker by using the
+following function in a mapping: >
+
+  :lua require("metals").fzf_menu()
+<
+
+NOTE: If you'd rather utilize |vim.ui.select| for this, a more generic
 |commands()| is available in the |metals-lua-api|.
 
 vim:tw=80:ts=2:ft=help:

lua/fzf-lua/_extensions/metals.lua

@@ -0,0 +1,45 @@
+local log = require("metals.log")
+local commands_table = require("metals.commands").commands_table
+
+local has_fzf, fzf = pcall(require, "fzf-lua")
+
+if not has_fzf then
+  local msg = "fzf-lua must be installed to use this functionality (https://github.com/ibhagwan/fzf-lua)"
+  log.error_and_show(msg)
+end
+
+local function run_entry(entry)
+  local command = require("metals")[entry.id]
+  local success, msg = pcall(command)
+  if not success then
+    vim.api.nvim_notify(msg, 2, {})
+  end
+end
+
+local function run_selected(label)
+  for _, entry in ipairs(commands_table) do
+    if entry.label == label then
+      run_entry(entry)
+      return
+    end
+  end
+end
+
+return function(opts)
+  opts = opts or {}
+  opts.prompt = "Metals Commands> "
+  opts.previewer = false
+  opts.actions = {
+    ["default"] = function(sel)
+      run_selected(sel[1])
+    end,
+  }
+  opts.winopts = { width = 40, height = 12, fullscreen = false }
+
+  local labels = {}
+  for _, entry in ipairs(commands_table) do
+    table.insert(labels, entry.label)
+  end
+
+  return fzf.fzf_exec(labels, opts)
+end

lua/metals.lua

@@ -536,4 +536,6 @@ M.commands = function()
   end)
 end
 
+M.fzf_menu = require("fzf-lua._extensions.metals")
+
 return M