feat: position documentation based on desired size, not max size

Author: Saghen

lua/blink/cmp/config.lua

@@ -134,9 +134,10 @@
 --- @alias blink.cmp.WindowBorder 'single' | 'double' | 'rounded' | 'solid' | 'shadow' | 'padded' | 'none' | blink.cmp.WindowBorderChar[]
 ---
 --- @class blink.cmp.DocumentationConfig
---- @field min_width? number
 --- @field max_width? number
 --- @field max_height? number
+--- @field desired_min_width? number
+--- @field desired_min_height? number
 --- @field border? blink.cmp.WindowBorder
 --- @field direction_priority? blink.cmp.DocumentationDirectionPriorityConfig
 --- @field auto_show? boolean
@@ -397,9 +398,10 @@ local config = {
       },
     },
     documentation = {
-      min_width = 10,
       max_width = 80,
       max_height = 20,
+      desired_min_width = 40,
+      desired_min_height = 10,
       border = 'padded',
       winblend = 0,
       winhighlight = 'Normal:BlinkCmpDoc,FloatBorder:BlinkCmpDocBorder,CursorLine:BlinkCmpDocCursorLine,Search:None',

lua/blink/cmp/windows/documentation.lua

@@ -121,7 +121,13 @@ function docs.update_position()
   end
 
   -- decide direction, width and height of window
-  local pos = docs.win:get_direction_with_window_constraints(autocomplete.win, direction_priority)
+  local width = docs.win:get_width()
+  local height = docs.win:get_height()
+  local pos = docs.win:get_direction_with_window_constraints(
+    autocomplete.win,
+    direction_priority,
+    { width = math.min(width, config.desired_min_width), height = math.min(height, config.desired_min_height) }
+  )
 
   -- couldn't find anywhere to place the window
   if not pos then

lua/blink/cmp/windows/lib/init.lua

@@ -29,7 +29,7 @@
 --- @field get_width fun(self: blink.cmp.Window): number
 --- @field get_cursor_screen_position fun(): { distance_from_top: number, distance_from_bottom: number }
 --- @field get_vertical_direction_and_height fun(self: blink.cmp.Window, direction_priority: ("n" | "s")[]): { height: number, direction: 'n' | 's' }?
---- @field get_direction_with_window_constraints fun(self: blink.cmp.Window, anchor_win: blink.cmp.Window, direction_priority: ("n" | "s" | "e" | "w")[]): { width: number, height: number, direction: 'n' | 's' | 'e' | 'w' }?
+--- @field get_direction_with_window_constraints fun(self: blink.cmp.Window, anchor_win: blink.cmp.Window, direction_priority: ("n" | "s" | "e" | "w")[], desired_min_size?: { width: number, height: number }): { width: number, height: number, direction: 'n' | 's' | 'e' | 'w' }?
 
 --- @type blink.cmp.Window
 --- @diagnostic disable-next-line: missing-fields
@@ -236,7 +236,7 @@ function win:get_vertical_direction_and_height(direction_priority)
   return { height = height - border_size.vertical, direction = direction }
 end
 
-function win:get_direction_with_window_constraints(anchor_win, direction_priority)
+function win:get_direction_with_window_constraints(anchor_win, direction_priority, desired_min_size)
   local cursor_constraints = self.get_cursor_screen_position()
 
   local anchor_config = vim.fn.screenpos(anchor_win:get_win(), 1, 1)
@@ -289,6 +289,19 @@ function win:get_direction_with_window_constraints(anchor_win, direction_priorit
   local direction_priority_by_space = vim.fn.sort(vim.deepcopy(direction_priority), function(a, b)
     local constraints_a = direction_constraints[a]
     local constraints_b = direction_constraints[b]
+
+    local is_desired_a = desired_min_size.height <= constraints_a.vertical
+      and desired_min_size.width <= constraints_a.horizontal
+    local is_desired_b = desired_min_size.height <= constraints_b.vertical
+      and desired_min_size.width <= constraints_b.horizontal
+
+    -- prioritize "a" if it has the desired size
+    if is_desired_a then return -1 end
+
+    -- prioritize "b" if it has the desired size and "a" doesn't
+    if not is_desired_a and is_desired_b then return 1 end
+
+    -- neither have the desired size, so pick based on which has the most space
     local distance_a = math.min(max_height, constraints_a.vertical, constraints_a.horizontal)
     local distance_b = math.min(max_height, constraints_b.vertical, constraints_b.horizontal)
     return distance_a < distance_b and 1 or distance_a > distance_b and -1 or 0