fix(extra): update pickers to respect 'mini.pick' global source config

Resolve #1799

Author: echasnovski

lua/mini/extra.lua

@@ -1467,8 +1467,7 @@ MiniExtra.pickers.visit_paths = function(local_opts, opts)
 
   local name = string.format('Visit paths (%s)', is_for_cwd and 'cwd' or 'all')
   local default_source = { name = name, cwd = picker_cwd, match = match, show = show }
-  opts = vim.tbl_deep_extend('force', { source = default_source }, opts or {}, { source = { items = items } })
-  return pick.start(opts)
+  return H.pick_start(items, { source = default_source }, opts)
 end
 
 --- Visit labels from 'mini.visits' picker
@@ -1539,8 +1538,7 @@ MiniExtra.pickers.visit_labels = function(local_opts, opts)
 
   local name = string.format('Visit labels (%s)', is_for_cwd and 'cwd' or 'all')
   local default_source = { name = name, cwd = picker_cwd, preview = preview, choose = choose }
-  opts = vim.tbl_deep_extend('force', { source = default_source }, opts or {}, { source = { items = items } })
-  return pick.start(opts)
+  return H.pick_start(items, { source = default_source }, opts)
 end
 
 -- Helper data ================================================================
@@ -1653,14 +1651,7 @@ end
 
 H.pick_start = function(items, default_opts, opts)
   local pick = H.validate_pick()
-  local fallback = {
-    source = {
-      preview = pick.default_preview,
-      choose = pick.default_choose,
-      choose_marked = pick.default_choose_marked,
-    },
-  }
-  local opts_final = vim.tbl_deep_extend('force', fallback, default_opts, opts or {}, { source = { items = items } })
+  local opts_final = vim.tbl_deep_extend('force', default_opts, opts or {}, { source = { items = items } })
   return pick.start(opts_final)
 end
 

tests/test_extra.lua

@@ -745,6 +745,26 @@ T['pickers'] = new_set({
   },
 })
 
+local validate_global_source_options = function(picker_start, check_preview, check_choose)
+  child.lua([[
+    MiniPick.config.source.preview = function(buf_id, item)
+      vim.api.nvim_buf_set_lines(buf_id, 0, -1, false, { "My preview" })
+      _G.custom_preview = true
+    end
+    MiniPick.config.source.choose = function(item)
+      _G.custom_choose = true
+    end
+  ]])
+  picker_start()
+  local ref_custom_preview = check_preview == false and vim.NIL or true
+  type_keys('<Tab>')
+  eq(child.lua_get('_G.custom_preview'), ref_custom_preview)
+  local ref_custom_choose = check_choose == false and vim.NIL or true
+  type_keys('<CR>')
+  eq(child.lua_get('_G.custom_choose'), ref_custom_choose)
+  type_keys('<C-c>')
+end
+
 T['pickers']["validate no 'mini.pick'"] = function()
   child.lua([[require = function(module) error() end]])
 
@@ -898,6 +918,10 @@ T['pickers']['buf_lines()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['buf_lines()']['respects global source options'] = function()
+  validate_global_source_options(pick_buf_lines, true, true)
+end
+
 T['pickers']['buf_lines()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.buf_lines(...)', { local_opts }) end, error_pattern)
@@ -959,6 +983,10 @@ T['pickers']['commands()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['commands()']['respects global source options'] = function()
+  validate_global_source_options(pick_commands, false, false)
+end
+
 T['pickers']['diagnostic()'] = new_set({
   hooks = {
     pre_case = function()
@@ -1098,6 +1126,10 @@ T['pickers']['diagnostic()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['diagnostic()']['respects global source options'] = function()
+  validate_global_source_options(pick_diagnostic, true, false)
+end
+
 T['pickers']['diagnostic()']['does not modify diagnostic table'] = function()
   local diagnostic_current = child.lua_get('vim.diagnostic.get()')
   pick_diagnostic()
@@ -1292,6 +1324,10 @@ T['pickers']['explorer()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['explorer()']['respects global source options'] = function()
+  validate_global_source_options(pick_explorer, true, false)
+end
+
 T['pickers']['explorer()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.explorer(...)', { local_opts }) end, error_pattern)
@@ -1415,6 +1451,10 @@ T['pickers']['git_branches()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['git_branches()']['respects global source options'] = function()
+  validate_global_source_options(pick_git_branches, false, false)
+end
+
 T['pickers']['git_branches()']['validates git'] = function()
   -- CLI
   mock_fn_executable({})
@@ -1539,6 +1579,10 @@ T['pickers']['git_commits()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['git_commits()']['respects global source options'] = function()
+  validate_global_source_options(pick_git_branches, false, false)
+end
+
 T['pickers']['git_commits()']['validates git'] = function()
   -- CLI
   mock_fn_executable({})
@@ -1670,6 +1714,14 @@ T['pickers']['git_files()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['git_files()']['respects global source options'] = function()
+  local repo_dir = test_dir_absolute
+  child.fn.chdir(repo_dir)
+  mock_git_repo(repo_dir)
+  mock_cli_return({ 'git-files/git-file-1', 'git-files/git-file-2' })
+  validate_global_source_options(pick_git_files, true, true)
+end
+
 T['pickers']['git_files()']['validates git'] = function()
   -- CLI
   mock_fn_executable({})
@@ -1859,6 +1911,15 @@ T['pickers']['git_hunks()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['git_hunks()']['respects global source options'] = function()
+  local repo_dir = test_dir_absolute
+  child.fn.chdir(repo_dir)
+  mock_git_repo(repo_dir)
+  local diff_lines = child.fn.readfile(join_path('mocks', 'git-diff'))
+  mock_cli_return(diff_lines)
+  validate_global_source_options(pick_git_hunks, false, true)
+end
+
 T['pickers']['git_hunks()']['validates git'] = function()
   -- CLI
   mock_fn_executable({})
@@ -1996,6 +2057,11 @@ T['pickers']['hipatterns()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['hipatterns()']['respects global source options'] = function()
+  setup_hipatterns()
+  validate_global_source_options(pick_hipatterns, true, true)
+end
+
 T['pickers']['hipatterns()']["checks for present 'mini.hipatterns'"] = function()
   child.lua([[
     local require_orig = require
@@ -2153,6 +2219,10 @@ T['pickers']['history()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['history()']['respects global source options'] = function()
+  validate_global_source_options(pick_history, false, false)
+end
+
 T['pickers']['history()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.history(...)', { local_opts }) end, error_pattern)
@@ -2213,6 +2283,10 @@ T['pickers']['hl_groups()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['hl_groups()']['respects global source options'] = function()
+  validate_global_source_options(pick_hl_groups, false, false)
+end
+
 T['pickers']['keymaps()'] = new_set()
 
 local pick_keymaps = forward_lua_notify('MiniExtra.pickers.keymaps')
@@ -2352,6 +2426,10 @@ T['pickers']['keymaps()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['keymaps()']['respects global source options'] = function()
+  validate_global_source_options(pick_keymaps, false, false)
+end
+
 T['pickers']['keymaps()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.keymaps(...)', { local_opts }) end, error_pattern)
@@ -2498,6 +2576,14 @@ T['pickers']['list()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['list()']['respects global source options'] = function()
+  local path = real_file('a.lua')
+  child.cmd('edit ' .. path)
+  type_keys('G')
+  type_keys('gg')
+  validate_global_source_options(function() pick_list({ scope = 'jump' }) end, true, false)
+end
+
 T['pickers']['list()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.list(...)', { local_opts }) end, error_pattern)
@@ -2740,6 +2826,11 @@ T['pickers']['lsp()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['lsp()']['respects global source options'] = function()
+  setup_lsp()
+  validate_global_source_options(function() pick_lsp({ scope = 'document_symbol' }) end, true, false)
+end
+
 T['pickers']['lsp()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.lsp(...)', { local_opts }) end, error_pattern)
@@ -2836,6 +2927,11 @@ T['pickers']['marks()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['marks()']['respects global source options'] = function()
+  setup_marks()
+  validate_global_source_options(pick_marks, true, true)
+end
+
 T['pickers']['marks()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.marks(...)', { local_opts }) end, error_pattern)
@@ -2924,6 +3020,13 @@ T['pickers']['oldfiles()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['oldfiles()']['respects global source options'] = function()
+  local path_1, path_2 = real_file('LICENSE'), make_testpath('mocks', 'diagnostic.lua')
+  local ref_oldfiles = { full_path(path_1), full_path(path_2), 'not-existing' }
+  child.v.oldfiles = ref_oldfiles
+  validate_global_source_options(pick_oldfiles, true, true)
+end
+
 T['pickers']['oldfiles()']['respects `opts.source.cwd`'] = function()
   child.set_size(10, 70)
   local ref_oldfiles = { full_path(real_file('LICENSE')), full_path(make_testpath('mocks', 'diagnostic.lua')) }
@@ -3035,6 +3138,10 @@ T['pickers']['options()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['options()']['respects global source options'] = function()
+  validate_global_source_options(pick_options, false, false)
+end
+
 T['pickers']['options()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.options(...)', { local_opts }) end, error_pattern)
@@ -3160,6 +3267,11 @@ T['pickers']['registers()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['registers()']['respects global source options'] = function()
+  setup_registers()
+  validate_global_source_options(pick_registers, false, false)
+end
+
 T['pickers']['spellsuggest()'] = new_set()
 
 local pick_spellsuggest = forward_lua_notify('MiniExtra.pickers.spellsuggest')
@@ -3203,6 +3315,11 @@ T['pickers']['spellsuggest()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['spellsuggest()']['respects global source options'] = function()
+  setup_spell()
+  validate_global_source_options(pick_spellsuggest, false, false)
+end
+
 T['pickers']['spellsuggest()']['validates arguments'] = function()
   local validate = function(local_opts, error_pattern)
     expect.error(function() child.lua('MiniExtra.pickers.spellsuggest(...)', { local_opts }) end, error_pattern)
@@ -3265,6 +3382,11 @@ T['pickers']['treesitter()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['treesitter()']['respects global source options'] = function()
+  setup_treesitter()
+  validate_global_source_options(pick_treesitter, true, true)
+end
+
 local setup_visits = function()
   -- NOTE: 'mini.visits' uses forward slashes in index
   local dir = test_dir_absolute:gsub('\\', '/')
@@ -3366,6 +3488,11 @@ T['pickers']['visit_paths()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['visit_paths()']['respects global source options'] = function()
+  setup_visits()
+  validate_global_source_options(pick_visit_paths, true, true)
+end
+
 T['pickers']['visit_paths()']["checks for present 'mini.visits'"] = function()
   child.lua([[
     local require_orig = require
@@ -3448,6 +3575,11 @@ T['pickers']['visit_labels()']['respects `opts`'] = function()
   validate_picker_name('My name')
 end
 
+T['pickers']['visit_labels()']['respects global source options'] = function()
+  setup_visits()
+  validate_global_source_options(pick_visit_labels, false, false)
+end
+
 T['pickers']['visit_labels()']["checks for present 'mini.visits'"] = function()
   child.lua([[
     local require_orig = require