(mini.extra) Update pickers.lsp to have symbol_query local option.

Details:
- The main reason for adding this is to account for some LSP servers
  which don't properly support "workspace/symbol" request with empty
  string as query. It should return all symbols, but some servers (like
  `pyright`) return nothing.
  The new `local_opts.symbol_query` can be used together with
  `vim.fn.input('Symbol: ')` to get symbol interactively from user
  prior to sending the request and showing results in the picker.

Author: echasnovski

doc/mini-extra.txt

@@ -609,6 +609,8 @@ Parameters~
   Possible fields:
   - <scope> `(string)` - LSP method to use. One of the supported ones (see
     list above). Default: `nil` which means explicit scope is needed.
+  - <symbol_query> `(string)` - query for |vim.lsp.buf.workspace_symbol()|.
+    Default: empty string for all symbols (according to LSP specification).
 {opts} `(table|nil)` Options forwarded to |MiniPick.start()|.
 
 Return~

lua/mini/extra.lua

@@ -1080,13 +1080,15 @@ end
 ---   Possible fields:
 ---   - <scope> `(string)` - LSP method to use. One of the supported ones (see
 ---     list above). Default: `nil` which means explicit scope is needed.
+---   - <symbol_query> `(string)` - query for |vim.lsp.buf.workspace_symbol()|.
+---     Default: empty string for all symbols (according to LSP specification).
 ---@param opts __extra_pickers_opts
 ---
 ---@return nil Nothing is returned.
 MiniExtra.pickers.lsp = function(local_opts, opts)
   if vim.fn.has('nvim-0.8') == 0 then H.error('`pickers.lsp` requires Neovim>=0.8.') end
   local pick = H.validate_pick('lsp')
-  local_opts = vim.tbl_deep_extend('force', { scope = nil }, local_opts or {})
+  local_opts = vim.tbl_deep_extend('force', { scope = nil, symbol_query = '' }, local_opts or {})
 
   if local_opts.scope == nil then H.error('`pickers.lsp` needs an explicit scope.') end
   --stylua: ignore
@@ -1096,7 +1098,10 @@ MiniExtra.pickers.lsp = function(local_opts, opts)
   local scope = H.pick_validate_scope(local_opts, allowed_scopes, 'lsp')
 
   if scope == 'references' then return vim.lsp.buf[scope](nil, { on_list = H.lsp_make_on_list(scope, opts) }) end
-  if scope == 'workspace_symbol' then return vim.lsp.buf[scope]('', { on_list = H.lsp_make_on_list(scope, opts) }) end
+  if scope == 'workspace_symbol' then
+    local query = tostring(local_opts.symbol_query)
+    return vim.lsp.buf[scope](query, { on_list = H.lsp_make_on_list(scope, opts) })
+  end
   vim.lsp.buf[scope]({ on_list = H.lsp_make_on_list(scope, opts) })
 end
 

tests/dir-extra/mocks/lsp.lua

@@ -79,8 +79,9 @@ vim.lsp.buf.type_definition = function(opts)
   opts.on_list(data)
 end
 
-vim.lsp.buf.workspace_symbol = function(_, opts)
+vim.lsp.buf.workspace_symbol = function(query, opts)
   table.insert(_G.lsp_buf_calls, 'workspace_symbol')
+  _G.workspace_symbol_query = query
   local data = {
     context = make_context('textDocument/workspaceSymbol'),
     items = {

tests/test_extra.lua

@@ -2445,6 +2445,7 @@ local validate_symbol_scope = function(scope)
   pick_lsp({ scope = scope })
   validate_picker_name('LSP (' .. scope .. ')')
   eq(child.lua_get('_G.lsp_buf_calls'), { scope })
+  if scope == 'workspace_symbol' then eq(child.lua_get('_G.workspace_symbol_query'), '') end
   child.expect_screenshot()
 
   -- Should highlight some symbols
@@ -2518,6 +2519,14 @@ T['pickers']['lsp()']['works for `type_definition`'] = function() validate_locat
 
 T['pickers']['lsp()']['works for `workspace_symbol`'] = function() validate_symbol_scope('workspace_symbol') end
 
+T['pickers']['lsp()']['respects `local_opts.symbol_query`'] = function()
+  if child.fn.has('nvim-0.8') == 0 then return end
+  setup_lsp()
+
+  pick_lsp({ scope = 'workspace_symbol', symbol_query = 'aaa' })
+  eq(child.lua_get('_G.workspace_symbol_query'), 'aaa')
+end
+
 T['pickers']['lsp()']['throws error on Neovim<0.8'] = function()
   if child.fn.has('nvim-0.8') == 1 then return end
   expect.error(function() child.lua([[MiniExtra.pickers.lsp({ scope = 'references' })]]) end, '`pickers%.lsp`.*0%.8')