(mini.notify) FEATURE: implement config.window.max_width_share.

Author: echasnovski

doc/mini-notify.txt

@@ -119,6 +119,9 @@ Default values:
       -- Floating window config
       config = {},
 
+      -- Maximum window width as share (between 0 and 1) of available columns
+      max_width_share = 0.382,
+
       -- Value of 'winblend' option
       winblend = 25,
     },
@@ -188,7 +191,8 @@ or a callable returning such table (will be called with identifier of
 window's buffer already showing notifications). It should have the same
 structure as in |nvim_open_win()|. It has the following default values
 which show notifications in the upper right corner with upper limit on width:
-- `width` is chosen to fit buffer content but not more than 38.2% of 'columns'.
+- `width` is chosen to fit buffer content but at most `window.max_width_share`
+  share of 'columns'.
   To have higher maximum width, use function in `config.window` which computes
   dimensions inside of it (based on buffer content).
 - `height` is chosen to fit buffer content with enabled 'wrap' (assuming
@@ -197,6 +201,10 @@ which show notifications in the upper right corner with upper limit on width:
 - `border` is "single".
 - `zindex` is 999 to be as much on top as reasonably possible.
 
+`window.max_width_share` defines maximum window width as a share of 'columns'.
+Should be a number between 0 (not included) and 1.
+Default: 0.382.
+
 `window.winblend` defines 'winblend' value for notification window.
 Default: 25.
 

lua/mini/notify.lua

@@ -175,7 +175,8 @@ end
 --- window's buffer already showing notifications). It should have the same
 --- structure as in |nvim_open_win()|. It has the following default values
 --- which show notifications in the upper right corner with upper limit on width:
---- - `width` is chosen to fit buffer content but not more than 38.2% of 'columns'.
+--- - `width` is chosen to fit buffer content but at most `window.max_width_share`
+---   share of 'columns'.
 ---   To have higher maximum width, use function in `config.window` which computes
 ---   dimensions inside of it (based on buffer content).
 --- - `height` is chosen to fit buffer content with enabled 'wrap' (assuming
@@ -184,6 +185,10 @@ end
 --- - `border` is "single".
 --- - `zindex` is 999 to be as much on top as reasonably possible.
 ---
+--- `window.max_width_share` defines maximum window width as a share of 'columns'.
+--- Should be a number between 0 (not included) and 1.
+--- Default: 0.382.
+---
 --- `window.winblend` defines 'winblend' value for notification window.
 --- Default: 25.
 MiniNotify.config = {
@@ -212,6 +217,9 @@ MiniNotify.config = {
     -- Floating window config
     config = {},
 
+    -- Maximum window width as share (between 0 and 1) of available columns
+    max_width_share = 0.382,
+
     -- Value of 'winblend' option
     winblend = 25,
   },
@@ -553,6 +561,7 @@ H.setup_config = function(config)
     ['lsp_progress.enable'] = { config.lsp_progress.enable, 'boolean' },
     ['lsp_progress.duration_last'] = { config.lsp_progress.duration_last, 'number' },
     ['window.config'] = { config.window.config, is_table_or_callable, 'table or callable' },
+    ['window.max_width_share'] = { config.window.max_width_share, 'number' },
     ['window.winblend'] = { config.window.winblend, 'number' },
   })
 
@@ -692,7 +701,7 @@ H.buffer_refresh = function(buf_id, notif_arr)
   end
 end
 
-H.buffer_default_dimensions = function(buf_id)
+H.buffer_default_dimensions = function(buf_id, max_width_share)
   local line_widths = vim.tbl_map(vim.fn.strdisplaywidth, vim.api.nvim_buf_get_lines(buf_id, 0, -1, true))
 
   -- Compute width so as to fit all lines
@@ -701,7 +710,9 @@ H.buffer_default_dimensions = function(buf_id)
     width = math.max(width, l_w)
   end
   -- - Limit from above for better visuals
-  width = math.min(width, math.floor(0.382 * vim.o.columns))
+  max_width_share = math.min(math.max(max_width_share, 0), 1)
+  local max_width = math.max(math.floor(max_width_share * vim.o.columns), 1)
+  width = math.min(width, max_width)
 
   -- Compute height based on the width so as to fit all lines with 'wrap' on
   local height = 0
@@ -734,14 +745,15 @@ H.window_compute_config = function(buf_id, is_for_open)
   local max_height = vim.o.lines - vim.o.cmdheight - (has_tabline and 1 or 0) - (has_statusline and 1 or 0)
   local max_width = vim.o.columns
 
+  local config_win = H.get_config().window
   local default_config = { relative = 'editor', style = 'minimal', noautocmd = is_for_open, zindex = 999 }
   default_config.anchor, default_config.col, default_config.row = 'NE', vim.o.columns, has_tabline and 1 or 0
-  default_config.width, default_config.height = H.buffer_default_dimensions(buf_id)
+  default_config.width, default_config.height = H.buffer_default_dimensions(buf_id, config_win.max_width_share)
   default_config.border = 'single'
   -- Don't allow focus to not disrupt window navigation
   default_config.focusable = false
 
-  local win_config = H.get_config().window.config
+  local win_config = config_win.config
   if vim.is_callable(win_config) then win_config = win_config(buf_id) end
   local config = vim.tbl_deep_extend('force', default_config, win_config or {})
 

readmes/mini-notify.md

@@ -176,6 +176,9 @@ Here are code snippets for some common installation methods (use only one):
     -- Floating window config
     config = {},
 
+    -- Maximum window width as share (between 0 and 1) of available columns
+    max_width_share = 0.382,
+
     -- Value of 'winblend' option
     winblend = 25,
   },

tests/screenshots/tests-test_notify.lua---Window---respects-`window.max_width_share`

@@ -0,0 +1,27 @@
+--|---------|---------|---------|---------|-----
+01|          ┌─────────────────────────────────┐
+02|~         │12:34:56 │ A very-very-very-very-│
+03|~         │very long notification           │
+04|~         └─────────────────────────────────┘
+05|~                                            
+06|~                                            
+07|~                                            
+08|~                                            
+09|~                                            
+10|~                                            
+11|~                                            
+12|                                             
+
+--|---------|---------|---------|---------|-----
+01|000000000011111111111111111111111111111111111
+02|222222222213333333333333333333333333333333331
+03|222222222213333333333333333333333333333333331
+04|222222222211111111111111111111111111111111111
+05|222222222222222222222222222222222222222222222
+06|222222222222222222222222222222222222222222222
+07|222222222222222222222222222222222222222222222
+08|222222222222222222222222222222222222222222222
+09|222222222222222222222222222222222222222222222
+10|222222222222222222222222222222222222222222222
+11|222222222222222222222222222222222222222222222
+12|444444444444444444444444444444444444444444444

tests/screenshots/tests-test_notify.lua---Window---respects-`window.max_width_share`-002

@@ -0,0 +1,27 @@
+--|---------|---------|---------|---------|-----
+01|┌───────────────────────────────────────────┐
+02|│12:34:56 │ A very-very-very-very-very long │
+03|│notification                               │
+04|└───────────────────────────────────────────┘
+05|~                                            
+06|~                                            
+07|~                                            
+08|~                                            
+09|~                                            
+10|~                                            
+11|~                                            
+12|                                             
+
+--|---------|---------|---------|---------|-----
+01|000000000000000000000000000000000000000000000
+02|011111111111111111111111111111111111111111110
+03|011111111111111111111111111111111111111111110
+04|000000000000000000000000000000000000000000000
+05|222222222222222222222222222222222222222222222
+06|222222222222222222222222222222222222222222222
+07|222222222222222222222222222222222222222222222
+08|222222222222222222222222222222222222222222222
+09|222222222222222222222222222222222222222222222
+10|222222222222222222222222222222222222222222222
+11|222222222222222222222222222222222222222222222
+12|333333333333333333333333333333333333333333333

tests/screenshots/tests-test_notify.lua---Window---respects-`window.max_width_share`-003

@@ -0,0 +1,27 @@
+--|---------|---------|---------|---------|-----
+01|┌───────────────────────────────────────────┐
+02|│12:34:56 │ A very-very-very-very-very long │
+03|│notification                               │
+04|└───────────────────────────────────────────┘
+05|~                                            
+06|~                                            
+07|~                                            
+08|~                                            
+09|~                                            
+10|~                                            
+11|~                                            
+12|                                             
+
+--|---------|---------|---------|---------|-----
+01|000000000000000000000000000000000000000000000
+02|011111111111111111111111111111111111111111110
+03|011111111111111111111111111111111111111111110
+04|000000000000000000000000000000000000000000000
+05|222222222222222222222222222222222222222222222
+06|222222222222222222222222222222222222222222222
+07|222222222222222222222222222222222222222222222
+08|222222222222222222222222222222222222222222222
+09|222222222222222222222222222222222222222222222
+10|222222222222222222222222222222222222222222222
+11|222222222222222222222222222222222222222222222
+12|333333333333333333333333333333333333333333333

tests/screenshots/tests-test_notify.lua---Window---respects-`window.max_width_share`-004

@@ -0,0 +1,27 @@
+--|---------|---------|---------|---------|-----
+01|                                          ┌─┐
+02|~                                         │1│
+03|~                                         │2│
+04|~                                         │:│
+05|~                                         │3│
+06|~                                         │4│
+07|~                                         │:│
+08|~                                         │5│
+09|~                                         │6│
+10|~                                         │ │
+11|~                                         └─┘
+12|                                             
+
+--|---------|---------|---------|---------|-----
+01|000000000000000000000000000000000000000000111
+02|222222222222222222222222222222222222222222131
+03|222222222222222222222222222222222222222222131
+04|222222222222222222222222222222222222222222131
+05|222222222222222222222222222222222222222222131
+06|222222222222222222222222222222222222222222131
+07|222222222222222222222222222222222222222222131
+08|222222222222222222222222222222222222222222131
+09|222222222222222222222222222222222222222222131
+10|222222222222222222222222222222222222222222131
+11|222222222222222222222222222222222222222222111
+12|444444444444444444444444444444444444444444444

tests/test_notify.lua

@@ -105,6 +105,7 @@ T['setup()']['creates `config` field'] = function()
   expect_config('lsp_progress.duration_last', 1000)
 
   expect_config('window.config', {})
+  expect_config('window.max_width_share', 0.382)
   expect_config('window.winblend', 25)
 end
 
@@ -132,6 +133,7 @@ T['setup()']['validates `config` argument'] = function()
 
   expect_config_error({ window = 'a' }, 'window', 'table')
   expect_config_error({ window = { config = 'a' } }, 'window.config', 'table or callable')
+  expect_config_error({ window = { max_width_share = 'a' } }, 'window.max_width_share', 'number')
   expect_config_error({ window = { winblend = 'a' } }, 'window.winblend', 'number')
 end
 
@@ -758,6 +760,24 @@ T['Window']['respects `window.config`'] = function()
   child.expect_screenshot()
 end
 
+T['Window']['respects `window.max_width_share`'] = function()
+  child.lua('MiniNotify.config.window.max_width_share = 0.75')
+  add('A very-very-very-very-very long notification')
+  child.expect_screenshot()
+  child.lua('MiniNotify.config.window.max_width_share = 1')
+  refresh()
+  child.expect_screenshot()
+
+  -- Handles out of range values
+  child.lua('MiniNotify.config.window.max_width_share = 10')
+  refresh()
+  child.expect_screenshot()
+
+  child.lua('MiniNotify.config.window.max_width_share = 0')
+  refresh()
+  child.expect_screenshot()
+end
+
 T['Window']['respects `window.winblend`'] = function()
   local validate_winblend = function(ref)
     local win_id = get_notif_win_id()