fix(files): account for 'cursorlineopt' to force show cursor line

Resolve #2084

Author: echasnovski

lua/mini/files.lua

@@ -1945,6 +1945,8 @@ H.explorer_show_help = function(explorer, explorer_buf_id, explorer_win_id)
   H.window_update_highlight(win_id, 'FloatTitle', 'MiniFilesTitle')
   H.window_update_highlight(win_id, 'CursorLine', 'MiniFilesCursorLine')
   vim.wo[win_id].cursorline = true
+  local culopt = vim.wo[win_id].cursorlineopt
+  if culopt:find('line') == nil then vim.wo[win_id].cursorlineopt = culopt .. ',line' end
 
   vim.api.nvim_set_current_win(win_id)
   return win_id
@@ -2504,8 +2506,10 @@ H.window_set_view = function(win_id, view)
 
   -- Set cursor (if defined), visible only in directories
   pcall(H.window_set_cursor, win_id, view.cursor)
-  -- NOTE: set 'cursorline' here because changing buffer might remove it
+  -- NOTE: set 'cursorline[opt]' here because changing buffer might remove it
   vim.wo[win_id].cursorline = H.fs_get_type(buf_data.path) == 'directory'
+  local culopt = vim.wo[win_id].cursorlineopt
+  if culopt:find('line') == nil then vim.wo[win_id].cursorlineopt = culopt .. ',line' end
 
   -- Update border highlight based on buffer status
   H.window_update_border_hl(win_id)

tests/dir-files/common/b-file

@@ -1 +1,2 @@
 b-file
+Another line

tests/screenshots/tests-test_files.lua---Default-explorer---works-in-`-tabfind-.`-002

@@ -1,6 +1,6 @@
 --|---------|---------|---------|---------|---------|---------|
 01|b-file                                                      
-02|~                                                           
+02|Another line                                                
 03|~                                                           
 04|~                                                           
 05|~                                                           
@@ -17,7 +17,7 @@
 
 --|---------|---------|---------|---------|---------|---------|
 01|000000000000000000000000000000000000000000000000000000000000
-02|111111111111111111111111111111111111111111111111111111111111
+02|000000000000000000000000000000000000000000000000000000000000
 03|111111111111111111111111111111111111111111111111111111111111
 04|111111111111111111111111111111111111111111111111111111111111
 05|111111111111111111111111111111111111111111111111111111111111

tests/screenshots/tests-test_files.lua---Default-explorer---works-in-`-vsplit-.`-002

@@ -1,6 +1,6 @@
 --|---------|---------|---------|---------|---------|---------|---------|---------|
 01|b-file                                  │                                       
-02|~                                       │~                                      
+02|Another line                            │~                                      
 03|~                                       │~                                      
 04|~                                       │~                                      
 05|~                                       │~                                      
@@ -17,17 +17,17 @@
 
 --|---------|---------|---------|---------|---------|---------|---------|---------|
 01|00000000000000000000000000000000000000001222222222222222222222222222222222222222
-02|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-03|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-04|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-05|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-06|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-07|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-08|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-09|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-10|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-11|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-12|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-13|33333333333333333333333333333333333333331444444444444444444444444444444444444444
-14|33333333333333333333333333333333333333331444444444444444444444444444444444444444
+02|00000000000000000000000000000000000000001333333333333333333333333333333333333333
+03|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+04|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+05|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+06|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+07|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+08|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+09|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+10|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+11|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+12|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+13|44444444444444444444444444444444444444441333333333333333333333333333333333333333
+14|44444444444444444444444444444444444444441333333333333333333333333333333333333333
 15|22222222222222222222222222222222222222222222222222222222222222222222222222222222

tests/screenshots/tests-test_files.lua---Windows---always-show-cursor-line-in-directories

@@ -0,0 +1,33 @@
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|┌MOCK_ROOT/tests/dir-files/common ─────────────────┐┌ .a-dir ─────────────────┐ 
+02|│ .a-dir                                          ││ aa-file                │ 
+03|│ a-dir                                           ││ ab-file                │ 
+04|│ b-dir                                           │└─────────────────────────┘ 
+05|│ .a-file                                         │                            
+06|│ a-file                                          │                            
+07|│ A-file-2                                        │                            
+08|│ b-file                                          │                            
+09|└──────────────────────────────────────────────────┘                            
+10|~                                                                               
+11|~                                                                               
+12|~                                                                               
+13|~                                                                               
+14|~                                                                               
+15|                                                              1,9-7         All 
+
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|01111111111111111111111111111111110000000000000000000222222220000000000000000003
+02|04444444455555555555555555555555555555555555555555500555555555555555555555555506
+03|07777777888888888888888888888888888888888888888888800888888888888888888888888806
+04|07777777888888888888888888888888888888888888888888800000000000000000000000000006
+05|08888888888888888888888888888888888888888888888888806666666666666666666666666666
+06|08888888888888888888888888888888888888888888888888806666666666666666666666666666
+07|08888888888888888888888888888888888888888888888888806666666666666666666666666666
+08|08888888888888888888888888888888888888888888888888806666666666666666666666666666
+09|00000000000000000000000000000000000000000000000000006666666666666666666666666666
+10|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+11|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+12|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+13|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+14|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+15|33333333333333333333333333333333333333333333333333333333333333333333333333333333

tests/screenshots/tests-test_files.lua---Windows---always-show-cursor-line-in-directories-002

@@ -0,0 +1,33 @@
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|┌MOCK_ROOT/tests/dir-files/common ─────────────────┐┌ b-file ─────────────────┐ 
+02|│ .a-dir                                          ││b-file                   │ 
+03|│ a-dir                                           ││Another line             │ 
+04|│ b-dir                                           │└─────────────────────────┘ 
+05|│ .a-file                                         │                            
+06|│ a-file                                          │                            
+07|│ A-file-2                                        │                            
+08|│ b-file                                          │                            
+09|└──────────────────────────────────────────────────┘                            
+10|~                                                                               
+11|~                                                                               
+12|~                                                                               
+13|~                                                                               
+14|~                                                                               
+15|                                                              7,9-7         All 
+
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|01111111111111111111111111111111110000000000000000000222222220000000000000000003
+02|04444444455555555555555555555555555555555555555555500555555555555555555555555506
+03|04444444555555555555555555555555555555555555555555500555555555555555555555555506
+04|04444444555555555555555555555555555555555555555555500000000000000000000000000006
+05|05555555555555555555555555555555555555555555555555506666666666666666666666666666
+06|05555555555555555555555555555555555555555555555555506666666666666666666666666666
+07|05555555555555555555555555555555555555555555555555506666666666666666666666666666
+08|07777777777777777777777777777777777777777777777777706666666666666666666666666666
+09|00000000000000000000000000000000000000000000000000006666666666666666666666666666
+10|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+11|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+12|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+13|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+14|66666666666666666666666666666666666666666666666666666666666666666666666666666666
+15|33333333333333333333333333333333333333333333333333333333333333333333333333333333

tests/test_files.lua

@@ -2545,6 +2545,24 @@ T['Windows']['correctly highlight content during editing'] = function()
   child.expect_screenshot()
 end
 
+T['Windows']['always show cursor line in directories'] = function()
+  child.o.cursorline = false
+  child.o.cursorlineopt = 'number'
+  open(test_dir_path, false, { windows = { preview = true } })
+  child.expect_screenshot()
+  eq(child.wo.cursorlineopt, 'number,line')
+
+  -- File preview should not show cursor line
+  type_keys('G')
+  child.expect_screenshot()
+  close()
+
+  -- Should preserve flags of 'cursorlineopt' as much as possible
+  child.o.cursorlineopt = 'screenline'
+  open(test_dir_path)
+  eq(child.wo.cursorlineopt, 'screenline')
+end
+
 T['Windows']['can be closed manually'] = function()
   open(test_dir_path)
   type_keys('G', '<CR>')