Provide custom search directory for ZkInsertLinkAtSelection

[tjex]

Verify

• I searched the existing discussions for similar ideas

Share your idea or feature request

Currently, when executing ZkInsertLinkAtSelection, we can pass options as defined for zk list. But it seems that the path option is not included in the zk-nvim api.

Only the options table is available to be passed (allowing for example to filter the picker by tags) -> :ZkInsertLinkAtSelection {tags = {"foo"}}. It would be great to include the pathvariable in the nvim api call, so that we can filter the picker to a certain directory (like when callingzk list foo`, in the terminal.

As per the documentation in this repo's readme, ZkInsertLinkAtSelection should take the same options as zk list.

" Inserts a link at the cursor location or around the selected text.
" params
"   (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist
"   One additional option is `matchSelected` (boolean) which is only applicable to inserting a link around selected text. If `true`, the note picker will search for notes similar to the selected text. Otherwise, the note picker will load all notes to filter through.
"    e.g. :'<'>ZkInsertLinkAtSelection {matchSelected = true}
:ZkInsertLink 
:'<,'>ZkInsertLinkAtSelection [{options}]

I've tried to pass a directory target when executing: e.g ZkInsertLinkAtSelection {dir = foo}, which is how it otherwise works with ZkNew {dir = foo}. I've also tried ZkInsertLinkAtSelection foo, and ZkInsertLinkAtSelection "foo" (error, that lua wants a table).

I had a look at the code and I think I found the right call:

/lua/zk.lua line 100

function M.pick_notes(options, picker_options, cb)
  options = vim.tbl_extend("force", { select = ui.get_pick_notes_list_api_selection(picker_options) }, options or {})
  api.list(options.notebook_path, options, function(err, notes)
    assert(not err, tostring(err))
    ui.pick_notes(notes, picker_options, cb)
  end)
end

This function is called by ZkInsertLinkAtSelection, which calls insert_link in lua/zk/commands/builtin.lua to open the picker. But the path is hard set to the option options.notebook_path.

Would it be an option to have a check before for a custom path, and if one exists, to append to notebook_path and it none is provided, to default to options.notebook_path?

[tjex]

The option I was actually looking for was there all along... Explained here in docs

ZkInsertLinkAtSelection { hrefs = {"target_folder"}}