feat(health): show :checkhealth in floating window #31086

Problem: health can not shown in a floating window
Solution: add g:health variable

1 files changed, 35 insertions, 6 deletions

diff --git a/runtime/lua/vim/health.lua b/runtime/lua/vim/health.lua
index 01166628b1..6dc902489f 100644
--- a/runtime/lua/vim/health.lua
+++ b/runtime/lua/vim/health.lua
@@ -11,6 +11,17 @@
 --- <
 --- Plugin authors are encouraged to write new healthchecks. |health-dev|
 ---
+---                                                              *g:health*
+--- g:health  This global variable controls the behavior and appearance of the
+---           `health` floating window. It should be a dictionary containing the
+---           following optional keys:
+---           - `style`: string? Determines the display style of the `health` window.
+---                             Set to `'float'` to enable a floating window. Other
+---                             styles are not currently supported.
+---
+---           Example: >lua
+---             vim.g.health = { style = 'float' }
+---
 --- Commands                                *health-commands*
 ---
 ---                                                              *:che* *:checkhealth*
@@ -331,13 +342,31 @@ function M._check(mods, plugin_names)
 
   local emptybuf = vim.fn.bufnr('$') == 1 and vim.fn.getline(1) == '' and 1 == vim.fn.line('$')
 
-  -- When no command modifiers are used:
-  -- - If the current buffer is empty, open healthcheck directly.
-  -- - If not specified otherwise open healthcheck in a tab.
-  local buf_cmd = #mods > 0 and (mods .. ' sbuffer') or emptybuf and 'buffer' or 'tab sbuffer'
-
   local bufnr = vim.api.nvim_create_buf(true, true)
-  vim.cmd(buf_cmd .. ' ' .. bufnr)
+  if
+    vim.g.health
+    and type(vim.g.health) == 'table'
+    and vim.tbl_get(vim.g.health, 'style') == 'float'
+  then
+    local max_height = math.floor(vim.o.lines * 0.8)
+    local max_width = 80
+    local float_bufnr, float_winid = vim.lsp.util.open_floating_preview({}, '', {
+      height = max_height,
+      width = max_width,
+      offset_x = math.floor((vim.o.columns - max_width) / 2),
+      offset_y = math.floor((vim.o.lines - max_height) / 2) - 1,
+      relative = 'editor',
+    })
+    vim.api.nvim_set_current_win(float_winid)
+    vim.bo[float_bufnr].modifiable = true
+    vim.wo[float_winid].list = false
+  else
+    -- When no command modifiers are used:
+    -- - If the current buffer is empty, open healthcheck directly.
+    -- - If not specified otherwise open healthcheck in a tab.
+    local buf_cmd = #mods > 0 and (mods .. ' sbuffer') or emptybuf and 'buffer' or 'tab sbuffer'
+    vim.cmd(buf_cmd .. ' ' .. bufnr)
+  end
 
   if vim.fn.bufexists('health://') == 1 then
     vim.cmd.bwipe('health://')