feat(lsp): add function to clear codelens (#21504)

Currently once you retrieve the lenses you're pretty much stuck with
them as saving new lenses is additive.

Adding a dedicated method to reset lenses allows users to toggle lenses
on/off which can be useful for language servers where they are noisy or
expensive and you only want to see them temporary.

1 files changed, 35 insertions, 0 deletions

diff --git a/test/functional/plugin/lsp/codelens_spec.lua b/test/functional/plugin/lsp/codelens_spec.lua
index ecc2f579b8..3d7a15a191 100644
--- a/test/functional/plugin/lsp/codelens_spec.lua
+++ b/test/functional/plugin/lsp/codelens_spec.lua
@@ -58,6 +58,41 @@ describe('vim.lsp.codelens', function()
     ]], bufnr)
 
     eq({[1] = {'Lens1', 'LspCodeLens'}}, virtual_text_chunks)
+  end)
+
+  it('can clear all lens', function()
+    local fake_uri = "file:///fake/uri"
+    local bufnr = exec_lua([[
+      fake_uri = ...
+      local bufnr = vim.uri_to_bufnr(fake_uri)
+      local lines = {'So', 'many', 'lines'}
+      vim.fn.bufload(bufnr)
+      vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
+      return bufnr
+    ]], fake_uri)
+
+    exec_lua([[
+      local bufnr = ...
+      local lenses = {
+        {
+          range = {
+            start = { line = 0, character = 0, },
+            ['end'] = { line = 0, character = 0 }
+          },
+          command = { title = 'Lens1', command = 'Dummy' }
+        },
+      }
+      vim.lsp.codelens.on_codelens(nil, lenses, {method='textDocument/codeLens', client_id=1, bufnr=bufnr})
+    ]], bufnr)
+
+    local stored_lenses = exec_lua('return vim.lsp.codelens.get(...)', bufnr)
+    eq(1, #stored_lenses)
+
+    exec_lua([[
+      vim.lsp.codelens.clear()
+    ]])
 
+    stored_lenses = exec_lua('return vim.lsp.codelens.get(...)', bufnr)
+    eq(0, #stored_lenses)
   end)
 end)