fix(clue): ensure even better key readability

Author: echasnovski

lua/mini/clue.lua

@@ -1914,7 +1914,10 @@ H.replace_termcodes = function(x)
   return vim.api.nvim_replace_termcodes(H.keytrans(x), true, true, true)
 end
 
-H.keytrans = function(x) return (vim.fn.keytrans(x):gsub('<lt>', '<'):gsub('<[Nn][Ll]>', '<C-J>')) end
+H.keytrans = function(x)
+  local res = vim.fn.keytrans(x):gsub('<NL>', '<C-J>'):gsub('<S%-NL>', '<C-S-J>'):gsub('<M%-NL>', '<C-M-J>')
+  return (res:gsub('<lt>', '<'))
+end
 
 H.get_forced_submode = function()
   local mode = vim.fn.mode(1)

tests/screenshots/tests-test_clue.lua---Clues---uses-human-readable-names-for-special-keys

@@ -2,21 +2,23 @@
 01|                                        
 02|~       ┌ <Space> ─────────────────────┐
 03|~       │ <C-J>     │                  │
-04|~       │ <C-Right> │                  │
-05|~       │ <C-X>     │                  │
-06|~       │ <End>     │                  │
-07|~       │ <F1>      │                  │
-08|~       │ <kRight>  │                  │
-09|~       │ <PageUp>  │                  │
-10|~       │ <Right>   │                  │
-11|~       │ <S-F1>    │                  │
-12|~       │ <S-Right> │                  │
-13|~       │ <Space>   │                  │
-14|~       │ <Tab>     │                  │
-15|~       │ <         │                  │
-16|~       └──────────────────────────────┘
-17|[No Name] 0,0-1                         
-18|                                        
+04|~       │ <C-M-J>   │                  │
+05|~       │ <C-Right> │                  │
+06|~       │ <C-S-J>   │                  │
+07|~       │ <C-X>     │                  │
+08|~       │ <End>     │                  │
+09|~       │ <F1>      │                  │
+10|~       │ <kRight>  │                  │
+11|~       │ <PageUp>  │                  │
+12|~       │ <Right>   │                  │
+13|~       │ <S-F1>    │                  │
+14|~       │ <S-Right> │                  │
+15|~       │ <Space>   │                  │
+16|~       │ <Tab>     │                  │
+17|~       │ <         │                  │
+18|~       └──────────────────────────────┘
+19|[No Name] 0,0-1                         
+20|                                        
 
 --|---------|---------|---------|---------|
 01|0000000000000000000000000000000000000000
@@ -34,6 +36,8 @@
 13|1111111124444444444456666666666666666662
 14|1111111124444444444456666666666666666662
 15|1111111124444444444456666666666666666662
-16|1111111122222222222222222222222222222222
-17|7777777777777777777777777777777777777777
-18|8888888888888888888888888888888888888888
+16|1111111124444444444456666666666666666662
+17|1111111124444444444456666666666666666662
+18|1111111122222222222222222222222222222222
+19|7777777777777777777777777777777777777777
+20|8888888888888888888888888888888888888888

tests/test_clue.lua

@@ -1660,13 +1660,15 @@ T['Clues']['can be configured after load'] = function()
 end
 
 T['Clues']['uses human-readable names for special keys'] = function()
-  child.set_size(18, 40)
+  child.set_size(20, 40)
   child.cmd('nmap <Space><Space> :echo 1<CR>')
   child.cmd('nmap <Space><Tab> :echo 2<CR>')
   child.cmd('nmap <Space><End> :echo 3<CR>')
   child.cmd('nmap <Space><PageUp> :echo 4<CR>')
   child.cmd('nmap <Space><C-x> :echo 5<CR>')
   child.cmd('nmap <Space><C-j> :echo 6<CR>')
+  child.cmd('nmap <Space><C-S-j> :echo 6.1<CR>')
+  child.cmd('nmap <Space><C-M-j> :echo 6.2<CR>')
   child.cmd('nmap <Space><Right> :echo 7<CR>')
   child.cmd('nmap <Space><C-Right> :echo 8<CR>')
   child.cmd('nmap <Space><S-Right> :echo 9<CR>')