Merge remote-tracking branch 'upstream/master' into mix_20240309

1 files changed, 72 insertions, 32 deletions

diff --git a/test/functional/plugin/lsp/utils_spec.lua b/test/functional/plugin/lsp/utils_spec.lua
index 6c6dec0667..64d58eeffd 100644
--- a/test/functional/plugin/lsp/utils_spec.lua
+++ b/test/functional/plugin/lsp/utils_spec.lua
@@ -11,21 +11,11 @@ describe('vim.lsp.util', function()
 
   describe('stylize_markdown', function()
     local stylize_markdown = function(content, opts)
-      return exec_lua(
-        [[
-        local bufnr = vim.uri_to_bufnr("file:///fake/uri")
+      return exec_lua(function()
+        local bufnr = vim.uri_to_bufnr('file:///fake/uri')
         vim.fn.bufload(bufnr)
-
-        local args = { ... }
-        local content = args[1]
-        local opts = args[2]
-        local stripped_content = vim.lsp.util.stylize_markdown(bufnr, content, opts)
-
-        return stripped_content
-      ]],
-        content,
-        opts
-      )
+        return vim.lsp.util.stylize_markdown(bufnr, content, opts)
+      end)
     end
 
     it('code fences', function()
@@ -93,9 +83,64 @@ describe('vim.lsp.util', function()
     end)
   end)
 
-  describe('normalize_markdown', function()
+  it('convert_input_to_markdown_lines', function()
+    local r = exec_lua(function()
+      local hover_data = {
+        kind = 'markdown',
+        value = '```lua\nfunction vim.api.nvim_buf_attach(buffer: integer, send_buffer: boolean, opts: vim.api.keyset.buf_attach)\n  -> boolean\n```\n\n---\n\n Activates buffer-update events. Example:\n\n\n\n ```lua\n events = {}\n vim.api.nvim_buf_attach(0, false, {\n   on_lines = function(...)\n     table.insert(events, {...})\n   end,\n })\n ```\n\n\n @see `nvim_buf_detach()`\n @see `api-buffer-updates-lua`\n@*param* `buffer` — Buffer handle, or 0 for current buffer\n\n\n\n@*param* `send_buffer` — True if whole buffer.\n Else the first notification will be `nvim_buf_changedtick_event`.\n\n\n@*param* `opts` — Optional parameters.\n\n - on_lines: Lua callback. Args:\n   - the string "lines"\n   - buffer handle\n   - b:changedtick\n@*return* — False if foo;\n\n otherwise True.\n\n@see foo\n@see bar\n\n',
+      }
+      return vim.lsp.util.convert_input_to_markdown_lines(hover_data)
+    end)
+    local expected = {
+      '```lua',
+      'function vim.api.nvim_buf_attach(buffer: integer, send_buffer: boolean, opts: vim.api.keyset.buf_attach)',
+      '  -> boolean',
+      '```',
+      '',
+      '---',
+      '',
+      ' Activates buffer-update events. Example:',
+      '',
+      '',
+      '',
+      ' ```lua',
+      ' events = {}',
+      ' vim.api.nvim_buf_attach(0, false, {',
+      '   on_lines = function(...)',
+      '     table.insert(events, {...})',
+      '   end,',
+      ' })',
+      ' ```',
+      '',
+      '',
+      ' @see `nvim_buf_detach()`',
+      ' @see `api-buffer-updates-lua`',
+      '',
+      -- For each @param/@return: #30695
+      --  - Separate each by one empty line.
+      --  - Remove all other blank lines.
+      '@*param* `buffer` — Buffer handle, or 0 for current buffer',
+      '',
+      '@*param* `send_buffer` — True if whole buffer.',
+      ' Else the first notification will be `nvim_buf_changedtick_event`.',
+      '',
+      '@*param* `opts` — Optional parameters.',
+      ' - on_lines: Lua callback. Args:',
+      '   - the string "lines"',
+      '   - buffer handle',
+      '   - b:changedtick',
+      '',
+      '@*return* — False if foo;',
+      ' otherwise True.',
+      '@see foo',
+      '@see bar',
+    }
+    eq(expected, r)
+  end)
+
+  describe('_normalize_markdown', function()
     it('collapses consecutive blank lines', function()
-      local result = exec_lua [[
+      local result = exec_lua(function()
         local lines = {
           'foo',
           '',
@@ -103,25 +148,25 @@ describe('vim.lsp.util', function()
           '',
           'bar',
           '',
-          'baz'
+          'baz',
         }
         return vim.lsp.util._normalize_markdown(lines)
-      ]]
+      end)
       local expected = { 'foo', '', 'bar', '', 'baz' }
       eq(expected, result)
     end)
 
     it('removes preceding and trailing empty lines', function()
-      local result = exec_lua [[
+      local result = exec_lua(function()
         local lines = {
           '',
           'foo',
           'bar',
           '',
-          ''
+          '',
         }
         return vim.lsp.util._normalize_markdown(lines)
-      ]]
+      end)
       local expected = { 'foo', 'bar' }
       eq(expected, result)
     end)
@@ -129,19 +174,14 @@ describe('vim.lsp.util', function()
 
   describe('make_floating_popup_options', function()
     local function assert_anchor(anchor_bias, expected_anchor)
-      local opts = exec_lua(
-        [[
-          local args = { ... }
-          local anchor_bias = args[1]
-          return vim.lsp.util.make_floating_popup_options(30, 10, { anchor_bias = anchor_bias })
-        ]],
-        anchor_bias
-      )
+      local opts = exec_lua(function()
+        return vim.lsp.util.make_floating_popup_options(30, 10, { anchor_bias = anchor_bias })
+      end)
 
       eq(expected_anchor, string.sub(opts.anchor, 1, 1))
     end
 
-    local screen
+    local screen --- @type test.functional.ui.screen
     before_each(function()
       n.clear()
       screen = Screen.new(80, 80)
@@ -221,9 +261,9 @@ describe('vim.lsp.util', function()
       end)
 
       it('bordered window truncates dimensions correctly', function()
-        local opts = exec_lua([[
+        local opts = exec_lua(function()
           return vim.lsp.util.make_floating_popup_options(100, 100, { border = 'single' })
-        ]])
+        end)
 
         eq(56, opts.height)
       end)