feat(basics)!: add options.win_border='auto' and make it default

Author: echasnovski

CHANGELOG.md

@@ -47,6 +47,16 @@ There are following change types:
 
 - Add `gen_spec.user_prompt` that acts the same as `?` built-in textobject. It can be used for using this textobject under another identifier.
 
+## mini.basics
+
+### Refine
+
+- Change default value of `options.win_border` to be `'auto'`.
+
+### Expand
+
+- Update `options.win_border` to allow value `'auto'` which infers target 'fillchars' values from 'winborder' option.
+
 ## mini.completion
 
 ### Evolve

doc/mini-basics.txt

@@ -83,7 +83,8 @@ Defaults ~
       extra_ui = false,
 
       -- Presets for window borders ('single', 'double', ...)
-      win_borders = 'default',
+      -- Default 'auto' infers from 'winborder' option
+      win_borders = 'auto',
     },
 
     -- Mappings. Set field to `false` to disable.
@@ -191,6 +192,7 @@ The `config.options.win_borders` updates |'fillchars'| to have a consistent set
 of characters for window border (`vert`, `horiz`, `msgsep`, etc.).
 
 Available values:
+- `'auto'` - infer from |'winborder'|. On Neovim<0.11 do nothing.
 - `'bold'` - bold lines.
 - `'dot'` - dot in every cell.
 - `'double'` - double line.

lua/mini/basics.lua

@@ -162,6 +162,7 @@ end
 --- of characters for window border (`vert`, `horiz`, `msgsep`, etc.).
 ---
 --- Available values:
+--- - `'auto'` - infer from |'winborder'|. On Neovim<0.11 do nothing.
 --- - `'bold'` - bold lines.
 --- - `'dot'` - dot in every cell.
 --- - `'double'` - double line.
@@ -322,7 +323,8 @@ MiniBasics.config = {
     extra_ui = false,
 
     -- Presets for window borders ('single', 'double', ...)
-    win_borders = 'default',
+    -- Default 'auto' infers from 'winborder' option
+    win_borders = 'auto',
   },
 
   -- Mappings. Set field to `false` to disable.
@@ -492,10 +494,13 @@ H.apply_options = function(config)
   end
 
   -- Use some common window borders presets
-  local border_chars = H.win_borders_fillchars[config.options.win_borders]
-  if border_chars ~= nil then
-    vim.opt.fillchars:append(border_chars)
+  local win_borders = config.options.win_borders
+  if win_borders == 'auto' and vim.fn.has('nvim-0.11') == 1 then
+    local option_value = vim.o.winborder
+    win_borders = H.winborder_map[option_value] or option_value
   end
+  local border_chars = H.win_borders_fillchars[win_borders]
+  if border_chars ~= nil then vim.opt.fillchars:append(border_chars) end
 end
 
 H.vim_o = setmetatable({}, {
@@ -524,6 +529,7 @@ H.win_borders_fillchars = {
   single = 'vert:│,horiz:─,horizdown:┬,horizup:┴,verthoriz:┼,vertleft:┤,vertright:├,msgsep:─',
   solid  = 'vert: ,horiz: ,horizdown: ,horizup: ,verthoriz: ,vertleft: ,vertright: ,msgsep: ',
 }
+H.winborder_map = { none = 'solid', rounded = 'single', shadow = 'solid' }
 
 -- Mappings -------------------------------------------------------------------
 --stylua: ignore

readmes/mini-basics.md

@@ -128,7 +128,8 @@ Here are code snippets for some common installation methods (use only one):
     extra_ui = false,
 
     -- Presets for window borders ('single', 'double', ...)
-    win_borders = 'default',
+    -- Default 'auto' infers from 'winborder' option
+    win_borders = 'auto',
   },
 
   -- Mappings. Set field to `false` to disable.

tests/test_basics.lua

@@ -44,7 +44,7 @@ T['setup()']['creates `config` field'] = function()
   -- Check default values
   expect_config('options.basic', true)
   expect_config('options.extra_ui', false)
-  expect_config('options.win_borders', 'default')
+  expect_config('options.win_borders', 'auto')
   expect_config('mappings.basic', true)
   expect_config('mappings.option_toggle_prefix', [[\]])
   expect_config('mappings.windows', false)
@@ -215,12 +215,41 @@ T['Options']['respect `config.options.extra_ui`'] = function()
 end
 
 T['Options']['respect `config.options.win_borders`'] = function()
-  eq(child.o.fillchars, '')
+  local validate = function(opt_value, ref_fillchars)
+    child.o.fillchars = ''
+    load_module({ options = { basic = false, win_borders = opt_value } })
+    eq(child.o.fillchars, ref_fillchars)
+  end
+
+  validate(nil, '')
+  validate('double', 'horiz:═,horizdown:╦,horizup:╩,msgsep:═,vert:║,verthoriz:╬,vertleft:╣,vertright:╠')
+  -- - Should not respect 'winborder' style names directly
+  validate('none', '')
+
+  if child.fn.has('nvim-0.11') == 0 then return end
+
+  -- With default 'auto' should infer from 'winborder' option
+  local validate_winborder = function(winborder_value, ref_fillchars)
+    child.o.winborder = winborder_value
+    validate(nil, ref_fillchars)
+    validate('auto', ref_fillchars)
+  end
+
+  validate_winborder('', '')
+
+  local single_fcs = 'horiz:─,horizdown:┬,horizup:┴,msgsep:─,vert:│,verthoriz:┼,vertleft:┤,vertright:├'
+  validate_winborder('single', single_fcs)
+  validate_winborder('rounded', single_fcs)
+
+  local solid_fcs = 'horiz: ,horizdown: ,horizup: ,msgsep: ,vert: ,verthoriz: ,vertleft: ,vertright: '
+  validate_winborder('solid', solid_fcs)
+  validate_winborder('none', solid_fcs)
+  validate_winborder('shadow', solid_fcs)
 
-  load_module({ options = { basic = false, win_borders = 'double' } })
+  if child.fn.has('nvim-0.12') == 0 then return end
 
-  local ref_value = 'horiz:═,horizdown:╦,horizup:╩,msgsep:═,vert:║,verthoriz:╬,vertleft:╣,vertright:╠'
-  eq(child.o.fillchars, ref_value)
+  -- With custom list 'winborder' should do nothing
+  validate_winborder('+,-,+,|,+,-,+,|', '')
 end
 
 T['Mappings'] = new_set()