feat(pick)!: set window-local current directory to source's cwd

Apart from being what appears to be a more logical behavior, this also
fixes current situation when `default_choose` and `default_preview`
don't respect source's cwd when item contains relative path (they used
to resolve them against working directory prior starting the picker).

Author: echasnovski

CHANGELOG.md

@@ -26,6 +26,8 @@
 
 ## mini.pick
 
+- BREAKING FEATURE: picker window now has local current directory set to source's `cwd`. This allows easier code for "in window" functions (callable items, choose, preview, etc.) as relative paths will be properly resolved. It also results in some changes:
+    - Calling `set_picker_items_from_cli()` with active picker now resolves explicitly set to relative path `spawn_opts.cwd` against picker's `cwd` (and not against global current directory as was done previously).
 - FEATURE: update `grep` and `grep_live` pickers to allow `globs` local option which restricts search to files that match any of its glob patterns (for example, `{ '*.lua', 'lua/**' }` will only search in Lua files and files in 'lua' directory). The `grep_live` picker also has custom `<C-o>` mapping to add globs interactively after picker is opened.
 - FEATURE: update `help` picker to have `default_split` local option which customizes split direction of `choose` action (`<CR>` by default).
 

doc/mini-pick.txt

@@ -229,7 +229,8 @@ want to just use provided pickers.
 `source.items` defines items to choose from. It should be one of the following:
 - Array of objects which can have different types. Any type is allowed.
 - `nil`. Picker waits for explicit |MiniPick.set_picker_items()| call.
-- Callable returning any of the previous types. Will be called once on start.
+- Callable returning any of the previous types. Will be called once on start
+  with source's `cwd` set as |current-directory|.
 
                                                 *MiniPick-source.items-stritems*
 Matching is done for items array based on the string representation of its
@@ -303,6 +304,9 @@ This is a part of source to allow persistent way to use relative paths,
 i.e. not depend on current directory being constant after picker start.
 It also makes the |MiniPick.builtin.resume()| picker more robust.
 
+It will be set as local |current-directory| (|:lcd|) of picker's main window
+to allow simpler code for "in window" functions (choose/preview/custom/etc.).
+
 Default value is |current-directory|.
 
                                                          *MiniPick-source.match*
@@ -1345,6 +1349,7 @@ Parameters ~
     Will be called with array of lines as input, should return array of items.
     Default: removes trailing empty lines and uses rest as string items.
   - <spawn_opts> `(table)` - `options` for |uv.spawn|, except `args` and `stdio` fields.
+    Note: relative `cwd` path is resolved against active picker's `cwd`.
   - <set_items_opts> `(table)` - table forwarded to |MiniPick.set_picker_items()|.
 
 See also ~

lua/mini/pick.lua

@@ -225,7 +225,8 @@
 --- `source.items` defines items to choose from. It should be one of the following:
 --- - Array of objects which can have different types. Any type is allowed.
 --- - `nil`. Picker waits for explicit |MiniPick.set_picker_items()| call.
---- - Callable returning any of the previous types. Will be called once on start.
+--- - Callable returning any of the previous types. Will be called once on start
+---   with source's `cwd` set as |current-directory|.
 ---
 ---                                                 *MiniPick-source.items-stritems*
 --- Matching is done for items array based on the string representation of its
@@ -299,6 +300,9 @@
 --- i.e. not depend on current directory being constant after picker start.
 --- It also makes the |MiniPick.builtin.resume()| picker more robust.
 ---
+--- It will be set as local |current-directory| (|:lcd|) of picker's main window
+--- to allow simpler code for "in window" functions (choose/preview/custom/etc.).
+---
 --- Default value is |current-directory|.
 ---
 ---                                                          *MiniPick-source.match*
@@ -1276,7 +1280,8 @@ MiniPick.builtin.files = function(local_opts, opts)
   opts = vim.tbl_deep_extend('force', default_opts, opts or {})
 
   if tool == 'fallback' then
-    opts.source.items = function() H.files_fallback_items(opts.source.cwd) end
+    local cwd = H.full_path(opts.source.cwd or vim.fn.getcwd())
+    opts.source.items = function() H.files_fallback_items(cwd) end
     return MiniPick.start(opts)
   end
 
@@ -1312,7 +1317,8 @@ MiniPick.builtin.grep = function(local_opts, opts)
 
   local pattern = type(local_opts.pattern) == 'string' and local_opts.pattern or vim.fn.input('Grep pattern: ')
   if tool == 'fallback' then
-    opts.source.items = function() H.grep_fallback_items(pattern, opts.source.cwd) end
+    local cwd = H.full_path(opts.source.cwd or vim.fn.getcwd())
+    opts.source.items = function() H.grep_fallback_items(pattern, cwd) end
     return MiniPick.start(opts)
   end
 
@@ -1347,7 +1353,8 @@ MiniPick.builtin.grep_live = function(local_opts, opts)
   local default_source = { name = string.format('Grep live (%s%s)', tool, name_suffix), show = show }
   opts = vim.tbl_deep_extend('force', { source = default_source }, opts or {})
 
-  local set_items_opts, spawn_opts = { do_match = false, querytick = H.querytick }, { cwd = opts.source.cwd }
+  local cwd = H.full_path(opts.source.cwd or vim.fn.getcwd())
+  local set_items_opts, spawn_opts = { do_match = false, querytick = H.querytick }, { cwd = cwd }
   local process
   local match = function(_, _, query)
     pcall(vim.loop.process_kill, process)
@@ -1499,7 +1506,9 @@ MiniPick.builtin.cli = function(local_opts, opts)
   local_opts = vim.tbl_deep_extend('force', { command = {}, postprocess = nil, spawn_opts = {} }, local_opts or {})
   local name = string.format('CLI (%s)', tostring(local_opts.command[1] or ''))
   opts = vim.tbl_deep_extend('force', { source = { name = name } }, opts or {})
-  local_opts.spawn_opts.cwd = local_opts.spawn_opts.cwd or opts.source.cwd
+  -- Explicitly use full path to not conflict with `set_picker_items_from_cli`
+  -- behavior of treating `spawn_opts.cwd` relative to source's cwd
+  local_opts.spawn_opts.cwd = H.full_path(local_opts.spawn_opts.cwd or opts.source.cwd or vim.fn.getcwd())
 
   local command = local_opts.command
   local set_from_cli_opts = { postprocess = local_opts.postprocess, spawn_opts = local_opts.spawn_opts }
@@ -1515,7 +1524,7 @@ MiniPick.builtin.resume = function()
   H.cache = {}
   local buf_id = H.picker_new_buf()
   local win_target = vim.api.nvim_get_current_win()
-  local win_id = H.picker_new_win(buf_id, picker.opts.window.config)
+  local win_id = H.picker_new_win(buf_id, picker.opts.window.config, picker.opts.source.cwd)
   picker.buffers = { main = buf_id }
   picker.windows = { main = win_id, target = win_target }
   picker.view_state = 'main'
@@ -1673,6 +1682,7 @@ end
 ---     Will be called with array of lines as input, should return array of items.
 ---     Default: removes trailing empty lines and uses rest as string items.
 ---   - <spawn_opts> `(table)` - `options` for |uv.spawn|, except `args` and `stdio` fields.
+---     Note: relative `cwd` path is resolved against active picker's `cwd`.
 ---   - <set_items_opts> `(table)` - table forwarded to |MiniPick.set_picker_items()|.
 ---
 ---@seealso |MiniPick.get_picker_items()| and |MiniPick.get_picker_stritems()|
@@ -1732,9 +1742,11 @@ end
 ---@seealso |MiniPick.get_picker_opts()|
 MiniPick.set_picker_opts = function(opts)
   if not MiniPick.is_picker_active() then return end
-  H.pickers.active.opts = vim.tbl_deep_extend('force', H.pickers.active.opts, opts or {})
-  H.pickers.active.action_keys = H.normalize_mappings(H.pickers.active.opts.mappings)
-  H.picker_update(H.pickers.active, true, true)
+  local picker, cur_cwd = H.pickers.active, H.pickers.active.opts.source.cwd
+  picker.opts = vim.tbl_deep_extend('force', picker.opts, opts or {})
+  picker.action_keys = H.normalize_mappings(picker.opts.mappings)
+  if cur_cwd ~= picker.opts.source.cwd then H.win_set_cwd(picker.windows.main, picker.opts.source.cwd) end
+  H.picker_update(picker, true, true)
 end
 
 --- Set target window for active picker
@@ -2076,7 +2088,7 @@ H.picker_new = function(opts)
 
   -- Create window
   local win_target = vim.api.nvim_get_current_win()
-  local win_id = H.picker_new_win(buf_id, opts.window.config)
+  local win_id = H.picker_new_win(buf_id, opts.window.config, opts.source.cwd)
 
   -- Construct and return object
   local picker = {
@@ -2178,7 +2190,7 @@ H.picker_new_buf = function()
   return buf_id
 end
 
-H.picker_new_win = function(buf_id, win_config)
+H.picker_new_win = function(buf_id, win_config, cwd)
   -- Hide cursor while picker is active (to not be visible in the window)
   -- This mostly follows a hack from 'folke/noice.nvim'
   H.cache.guicursor = vim.o.guicursor
@@ -2198,6 +2210,9 @@ H.picker_new_win = function(buf_id, win_config)
   H.win_update_hl(win_id, 'FloatBorder', 'MiniPickBorder')
   vim.fn.clearmatches(win_id)
 
+  -- Set window's local "current directory" for easier choose/preview/etc.
+  H.win_set_cwd(nil, cwd)
+
   return win_id
 end
 
@@ -3267,7 +3282,6 @@ end
 
 H.files_fallback_items = function(cwd)
   if vim.fn.has('nvim-0.9') == 0 then H.error('Tool "fallback" of `files` builtin needs Neovim>=0.9.') end
-  cwd = cwd or '.'
   local poke_picker = H.poke_picker_throttle()
   local f = function()
     local items = {}
@@ -3311,7 +3325,6 @@ end
 
 H.grep_fallback_items = function(pattern, cwd)
   if vim.fn.has('nvim-0.9') == 0 then H.error('Tool "fallback" of `grep` builtin needs Neovim>=0.9.') end
-  cwd = cwd or '.'
   local poke_picker = H.poke_picker_throttle()
   local f = function()
     local files, files_full = {}, {}
@@ -3478,6 +3491,14 @@ H.win_get_bottom_border = function(win_id)
   return res or ' '
 end
 
+H.win_set_cwd = function(win_id, cwd)
+  -- Avoid needlessly setting cwd as it has side effects (like for `:buffers`)
+  if cwd == nil or vim.fn.getcwd(win_id or 0) == cwd then return end
+  local f = function() vim.cmd('lcd ' .. vim.fn.fnameescape(cwd)) end
+  if win_id == nil or win_id == vim.api.nvim_get_current_win() then return f() end
+  vim.api.nvim_win_call(f, win_id)
+end
+
 H.seq_along = function(arr)
   if arr == nil then return nil end
   local res = {}

tests/dir-pick/file

@@ -0,0 +1 @@
+dir-pick/file

tests/screenshots/tests-test_pick.lua---Info-view---is-updated-after-moving-marking-current-item

@@ -6,7 +6,7 @@
 05|┌Info────────────────────┐              
 06|│General                 │              
 07|│Source name   │ My name │              
-08|│Source cwd    │ mock/cur│              
+08|│Source cwd    │ tests/di│              
 09|│Total items   │ 3       │              
 10|│Matched items │ 3       │              
 11|│Marked items  │ 0       │              

tests/screenshots/tests-test_pick.lua---Info-view---is-updated-after-moving-marking-current-item-002

@@ -6,7 +6,7 @@
 05|┌Info────────────────────┐              
 06|│General                 │              
 07|│Source name   │ My name │              
-08|│Source cwd    │ mock/cur│              
+08|│Source cwd    │ tests/di│              
 09|│Total items   │ 3       │              
 10|│Matched items │ 3       │              
 11|│Marked items  │ 0       │              

tests/screenshots/tests-test_pick.lua---Info-view---is-updated-after-moving-marking-current-item-003

@@ -6,7 +6,7 @@
 05|┌Info────────────────────┐              
 06|│General                 │              
 07|│Source name   │ My name │              
-08|│Source cwd    │ mock/cur│              
+08|│Source cwd    │ tests/di│              
 09|│Total items   │ 3       │              
 10|│Matched items │ 3       │              
 11|│Marked items  │ 1       │              

tests/screenshots/tests-test_pick.lua---Info-view---is-updated-after-moving-marking-current-item-004

@@ -6,7 +6,7 @@
 05|┌Info────────────────────┐              
 06|│General                 │              
 07|│Source name   │ My name │              
-08|│Source cwd    │ mock/cur│              
+08|│Source cwd    │ tests/di│              
 09|│Total items   │ 3       │              
 10|│Matched items │ 3       │              
 11|│Marked items  │ 0       │              

tests/screenshots/tests-test_pick.lua---Info-view---respects-custom-mappings

@@ -2,7 +2,7 @@
 01|┌Info─────────────────────────────────┐                     
 02|│General                              │                     
 03|│Source name   │ My name              │                     
-04|│Source cwd    │ mock/current-dir     │                     
+04|│Source cwd    │ tests/dir-pick       │                     
 05|│Total items   │ 3                    │                     
 06|│Matched items │ 3                    │                     
 07|│Marked items  │ 0                    │                     

tests/screenshots/tests-test_pick.lua---Info-view---supports-vertical-and-horizontal-scroll

@@ -6,7 +6,7 @@
 05|┌Info────────────────────┐              
 06|│l                       │              
 07|│ name   │ <No name>     │              
-08|│ cwd    │ mock/current-d│              
+08|│ cwd    │ tests/dir-pick│              
 09|│items   │ 1             │              
 10|│d items │ 1             │              
 11|│ items  │ 0             │