(mini.clue) Update querying process to repeatedly force redraw.

Author: echasnovski

lua/mini/clue.lua

@@ -1104,6 +1104,11 @@ H.keys = {
   ctrl_u = vim.api.nvim_replace_termcodes('<C-u>', true, true, true),
 }
 
+-- Timers
+H.timers = {
+  getcharstr = vim.loop.new_timer(),
+}
+
 -- Undo command which depends on Neovim version
 H.undo_autocommand = 'au ModeChanged * ++once undo' .. (vim.fn.has('nvim-0.8') == 1 and '!' or '')
 
@@ -1915,8 +1920,13 @@ H.is_valid_buf = function(buf_id) return type(buf_id) == 'number' and vim.api.nv
 
 H.is_valid_win = function(win_id) return type(win_id) == 'number' and vim.api.nvim_win_is_valid(win_id) end
 
+H.redraw_scheduled = vim.schedule_wrap(function() vim.cmd('redraw') end)
+
 H.getcharstr = function()
+  -- Ensure redraws still happen
+  H.timers.getcharstr:start(0, 50, H.redraw_scheduled)
   local ok, char = pcall(vim.fn.getcharstr)
+  H.timers.getcharstr:stop()
   -- Terminate if couldn't get input (like with <C-c>) or it is `<Esc>`
   if not ok or char == '\27' or char == '' then return end
   return H.get_langmap()[char] or char

tests/screenshots/tests-test_clue.lua---Querying-keys---does-not-entirely-block-redraws

@@ -0,0 +1,23 @@
+--|---------|---------|---------|---------|
+01|aaaa                                    
+02|~                                       
+03|~                                       
+04|~                                       
+05|~                                       
+06|~       ┌<Space>───────────────────────┐
+07|~       │ f │ Add hl                   │
+08|~       └──────────────────────────────┘
+09|[No Name] [+]         1,1            All
+10|                                        
+
+--|---------|---------|---------|---------|
+01|0111111111111111111111111111111111111111
+02|2222222222222222222222222222222222222222
+03|2222222222222222222222222222222222222222
+04|2222222222222222222222222222222222222222
+05|2222222222222222222222222222222222222222
+06|2222222234444444333333333333333333333333
+07|2222222235556777777777777777777777777773
+08|2222222233333333333333333333333333333333
+09|8888888888888888888888888888888888888888
+10|3333333333333333333333333333333333333333

tests/screenshots/tests-test_clue.lua---Querying-keys---does-not-entirely-block-redraws-002

@@ -0,0 +1,23 @@
+--|---------|---------|---------|---------|
+01|aaaa                                    
+02|~                                       
+03|~                                       
+04|~                                       
+05|~                                       
+06|~       ┌<Space>───────────────────────┐
+07|~       │ f │ Add hl                   │
+08|~       └──────────────────────────────┘
+09|[No Name] [+]         1,1            All
+10|                                        
+
+--|---------|---------|---------|---------|
+01|0011111111111111111111111111111111111111
+02|2222222222222222222222222222222222222222
+03|2222222222222222222222222222222222222222
+04|2222222222222222222222222222222222222222
+05|2222222222222222222222222222222222222222
+06|2222222234444444333333333333333333333333
+07|2222222235556777777777777777777777777773
+08|2222222233333333333333333333333333333333
+09|8888888888888888888888888888888888888888
+10|3333333333333333333333333333333333333333

tests/test_clue.lua

@@ -1916,6 +1916,36 @@ T['Querying keys']['works'] = function()
   eq(get_test_map_count('n', ' f'), 2)
 end
 
+T['Querying keys']['does not entirely block redraws'] = function()
+  child.set_size(10, 40)
+  set_lines({ 'aaaa' })
+  child.lua([[
+    local ns_id = vim.api.nvim_create_namespace('test')
+    local n = 0
+    _G.add_hl = function()
+      local col = n
+      vim.defer_fn(function()
+        vim.highlight.range(0, ns_id, 'Comment', { 0, col }, { 0, col + 1 }, {})
+      end, 5)
+      n = n + 1
+    end
+    vim.keymap.set('n', '<Space>f', _G.add_hl, { desc = 'Add hl' })]])
+
+  load_module({
+    clues = { { mode = 'n', keys = '<Space>f', postkeys = '<Space>' } },
+    triggers = { { mode = 'n', keys = '<Space>' } },
+  })
+
+  type_keys('<Space>', 'f')
+  -- - Redraws don't happen immediately but inside a repeating timer
+  sleep(50 + 5)
+  child.expect_screenshot()
+
+  type_keys('f')
+  sleep(50 + 5)
+  child.expect_screenshot()
+end
+
 T['Querying keys']['allows trigger with more than one character'] = function()
   make_test_map('n', '<Space>aa')
   load_module({ triggers = { { mode = 'n', keys = '<Space>a' } } })