feat(extra): add workspace_symbol_live scope to pickers.lsp()

Resolve #2113

Author: echasnovski

CHANGELOG.md

@@ -105,6 +105,8 @@ There are following change types:
 
 - Add `pickers.colorschemes` picker. By @pkazmier, PR #1789.
 
+- Add `workspace_symbol_live` live scope to `pickers.lsp` picker. This allows searching for LSP symbols in the workspace with live feedback. Relates to `workspace_symbol` scope similar to how `MiniPick.builtin.grep_live()` relates to `MiniPick.builtin.grep()`.
+
 - Add `<C-e>` mapping for `pickers.history` picker to edit commands or searches in cmdline. By @TheLeoP, PR #1960.
 
 ## mini.files

doc/mini-extra.txt

@@ -621,12 +621,16 @@ Notes:
     - "references".
     - "type_definition".
     - "workspace_symbol".
+    - "workspace_symbol_live" - same as "workspace_symbol", but with live
+      feedback treating picker's prompt as LSP server query. Similar to
+      how |MiniPick.builtin.grep_live()| and |MiniPick.builtin.grep()| are
+      related. To use regular matching, use |MiniPick-actions-refine|.
 - Relies on `vim.lsp.buf` methods supporting |vim.lsp.LocationOpts.OnList|.
   In particular, it means that picker is started only if LSP server returns
   list of locations and not a single location.
 - Doesn't return anything due to async nature of `vim.lsp.buf` methods.
 - Requires set up |mini.icons| to show extra icons and highlighting in
-  "document_symbol" and "workspace_symbol" scopes.
+  "document_symbol", "workspace_symbol", "workspace_symbol_live" scopes.
 
 Examples:
 
@@ -639,7 +643,7 @@ 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()|.
+  - <symbol_query> `(string)` - query for `"workspace_symbol"` scope.
     Default: empty string for all symbols (according to LSP specification).
 {opts} `(table|nil)` Options forwarded to |MiniPick.start()|.
 

doc/mini-pick.txt

@@ -563,7 +563,8 @@ This action is useful in at least two cases:
   both "hello" and "world" exact matches (in no particular order) with default
   matching, type "'hello" (notice "'" at the start) followed by `<C-Space>` and
   another "'world".
-- Reset `match` to default. Particularly useful in |MiniPick.builtin.grep_live()|.
+- Reset `match` to default. Particularly useful in |MiniPick.builtin.grep_live()|
+  and |MiniExtra.pickers.lsp()| with `scope='workspace_symbol_live'`.
 
 ## Scroll ~
 *MiniPick-actions-scroll*

lua/mini/extra.lua

@@ -1172,12 +1172,16 @@ end
 ---     - "references".
 ---     - "type_definition".
 ---     - "workspace_symbol".
+---     - "workspace_symbol_live" - same as "workspace_symbol", but with live
+---       feedback treating picker's prompt as LSP server query. Similar to
+---       how |MiniPick.builtin.grep_live()| and |MiniPick.builtin.grep()| are
+---       related. To use regular matching, use |MiniPick-actions-refine|.
 --- - Relies on `vim.lsp.buf` methods supporting |vim.lsp.LocationOpts.OnList|.
 ---   In particular, it means that picker is started only if LSP server returns
 ---   list of locations and not a single location.
 --- - Doesn't return anything due to async nature of `vim.lsp.buf` methods.
 --- - Requires set up |mini.icons| to show extra icons and highlighting in
----   "document_symbol" and "workspace_symbol" scopes.
+---   "document_symbol", "workspace_symbol", "workspace_symbol_live" scopes.
 ---
 --- Examples:
 ---
@@ -1189,7 +1193,7 @@ 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()|.
+---   - <symbol_query> `(string)` - query for `"workspace_symbol"` scope.
 ---     Default: empty string for all symbols (according to LSP specification).
 ---@param opts __extra_pickers_opts
 ---
@@ -1201,16 +1205,27 @@ MiniExtra.pickers.lsp = function(local_opts, opts)
   if local_opts.scope == nil then H.error('`pickers.lsp` needs an explicit scope.') end
   --stylua: ignore
   local allowed_scopes = {
-    'declaration', 'definition', 'document_symbol', 'implementation', 'references', 'type_definition', 'workspace_symbol',
+    'declaration', 'definition', 'document_symbol', 'implementation',
+    'references', 'type_definition', 'workspace_symbol', 'workspace_symbol_live'
   }
   local scope = H.pick_validate_scope(local_opts, allowed_scopes, 'lsp')
 
-  local buf_lsp_opts = H.lsp_make_opts(scope, opts)
+  local buf_lsp_opts, picker_opts = H.lsp_make_opts(scope, opts)
   if scope == 'references' then return vim.lsp.buf[scope](nil, buf_lsp_opts) end
   if scope == 'workspace_symbol' then
     local query = tostring(local_opts.symbol_query)
     return vim.lsp.buf[scope](query, buf_lsp_opts)
   end
+  if scope == 'workspace_symbol_live' then
+    picker_opts.source.match = function(_, _, query)
+      if #query == 0 then return MiniPick.set_picker_items({}, { do_match = false }) end
+      local win_id = MiniPick.get_picker_state().windows.target
+      local buf_id = vim.api.nvim_win_get_buf(win_id)
+      vim.api.nvim_buf_call(buf_id, function() vim.lsp.buf.workspace_symbol(table.concat(query), buf_lsp_opts) end)
+    end
+
+    return H.pick_start({}, picker_opts, opts)
+  end
   vim.lsp.buf[scope](buf_lsp_opts)
 end
 
@@ -1991,10 +2006,14 @@ H.lsp_make_opts = function(source, opts)
     end
     items = process(items)
 
+    if MiniPick.is_picker_active() and source == 'workspace_symbol_live' then
+      return MiniPick.set_picker_items(items, { do_match = false })
+    end
+
     return H.pick_start(items, picker_opts, opts)
   end
 
-  return { on_list = on_list }
+  return { on_list = on_list }, picker_opts
 end
 
 H.get_symbol_kind_map = function()

lua/mini/pick.lua

@@ -557,7 +557,8 @@
 ---   both "hello" and "world" exact matches (in no particular order) with default
 ---   matching, type "'hello" (notice "'" at the start) followed by `<C-Space>` and
 ---   another "'world".
---- - Reset `match` to default. Particularly useful in |MiniPick.builtin.grep_live()|.
+--- - Reset `match` to default. Particularly useful in |MiniPick.builtin.grep_live()|
+---   and |MiniExtra.pickers.lsp()| with `scope='workspace_symbol_live'`.
 ---
 --- ## Scroll ~
 --- *MiniPick-actions-scroll*

tests/test_extra.lua

@@ -2910,6 +2910,7 @@ local scope_to_request = {
   references = 'textDocument/references',
   type_definition = 'textDocument/typeDefinition',
   workspace_symbol = 'workspace/symbol',
+  workspace_symbol_live = 'workspace/symbol',
 }
 
 local validate_location_scope = function(scope)
@@ -3105,6 +3106,38 @@ T['pickers']['lsp()']['works for `workspace_symbol` after `MiniIcons.tweak_lsp_k
   validate_symbol_scope_with_tweaked_kind('workspace_symbol', 'replace')
 end
 
+T['pickers']['lsp()']['works for `workspace_symbol_live`'] = function()
+  -- Test only "live" part in the hope that "workspace_symbol" part is the same
+
+  setup_lsp()
+  mock_slash_path_sep()
+  pick_lsp({ scope = 'workspace_symbol_live' })
+  validate_picker_name('LSP (workspace_symbol_live)')
+
+  local validate = function(did_request, query)
+    eq(child.lua_get('#_G.lsp_requests > 0'), did_request)
+    eq(child.lua_get('_G.params'), query ~= nil and { query = query } or vim.NIL)
+
+    child.lua('_G.lsp_requests, _G.params = {}, nil')
+  end
+
+  -- Should not do any request on start
+  validate(false, nil)
+  eq(get_picker_items(), {})
+
+  -- Should make new request on every picker query change
+  type_keys('a')
+  validate(true, 'a')
+
+  type_keys('x')
+  validate(true, 'ax')
+
+  -- Should not make request for empty query and show no items instead
+  type_keys('<C-u>')
+  validate(false, nil)
+  eq(get_picker_items(), {})
+end
+
 T['pickers']['lsp()']['respects `local_opts.symbol_query`'] = function()
   setup_lsp()