Expose Notebook Root Directory in API

[mcDevnagh]

Verify

• I searched the existing discussions for similar ideas

Share your idea or feature request

I would like to access the Notebook Root Directory, with the following caveats

• without cding into it
  • so I can use dir in scripts, and pass it to other zk commands, like ZkNew
  • so I can maintain my context in another project for notes I need to write
• without re-implementing code in the plugin
• without using internal modules (like require("zk.util").resolve_notebook_path(0))

Currently, the best way to do this would be something like

function zk_dir()
  local zk = require("zk")
  local old_dir = vim.loop.cwd()
  zk.cd()
  local new_dir = vim.loop.cwd()
  vim.cmd.cd(old_dir)
  return new_dir
end

This, however, seems suboptimal.
I would be nice if zk.cd, had a dryRun option, much like zk.new, which kept the cwd untouched, and returned the directory it would otherwise go to.
https://github.com/mickael-menu/zk-nvim/blob/142625638d2fad464939c6ee1775571aba6379c6/lua/zk.lua#L53
Something like...

function M.cd(options)
  options = options or {}
  local notebook_path = options.notebook_path or util.resolve_notebook_path(0)
  local root = util.notebook_root(notebook_path)
  if options.dryRun == true then
    return root
  end

  if root then
    vim.cmd("cd " .. root)
  end
end