Multiple tree explorer

[notfound4]

I'd like to know if it is possible to provide explorer multiple path so that one tree is open for every path given. I'd also like to know if it is possible, using options, to add a node called "Favorites" where you could add files using a keybind + custom action.

If it is not possible, can I implement my own version of explorer ? If yes, where do I start from ?

Thanks for your help !

[drowning-cat]

Related:

1. List of favorite directories within explorer #2038 (comment)
2. Favorite files, harpoon clone (advanced, experimental) #1766

[drowning-cat]

I'd like to know if it is possible to provide explorer multiple path so that one tree is open for every path given.

It is possible, but not via option, so you need to override finder function (see related.1):

snacks.nvim/lua/snacks/picker/config/sources.lua

Lines 50 to 51 in fe7cfe9

	M.explorer = {
	finder = "explorer",

snacks.nvim/lua/snacks/picker/source/explorer.lua

Lines 190 to 264 in fe7cfe9

	---@param opts snacks.picker.explorer.Config
	---@type snacks.picker.finder
	function M.explorer(opts, ctx)
	local state = M.get_state(ctx.picker)
	ctx.picker.matcher.opts.keep_parents = false
	if state:setup(ctx) then
	ctx.picker.matcher.opts.keep_parents = true
	return M.search(opts, ctx)
	end
	-- initial on_find (typically for follow_file), has to be done both for:
	-- * regular explorer view
	-- * when git status refreshes the view
	local on_find = state.on_find
	state.on_find = nil
	if opts.git_status then
	require("snacks.explorer.git").update(ctx.filter.cwd, {
	untracked = opts.git_untracked,
	on_update = function()
	if ctx.picker.closed then
	return
	end
	ctx.picker.list:set_target()
	ctx.picker:find({ on_done = on_find })
	end,
	})
	end
	if opts.diagnostics then
	require("snacks.explorer.diagnostics").update(ctx.filter.cwd)
	end
	return function(cb)
	if on_find then
	assert(ctx.picker.matcher.task:running())
	ctx.picker.matcher.task:on("done", vim.schedule_wrap(on_find))
	end
	local items = {} ---@type table<string, snacks.picker.explorer.Item>
	local top = Tree:find(ctx.filter.cwd)
	local last = {} ---@type table<snacks.picker.explorer.Node, snacks.picker.explorer.Item>
	Tree:get(ctx.filter.cwd, function(node)
	local parent = node.parent and items[node.parent.path] or nil
	local status = node.status
	if not status and parent and parent.dir_status then
	status = parent.dir_status
	end
	local item = {
	file = node.path,
	dir = node.dir,
	open = node.open,
	dir_status = node.dir_status or parent and parent.dir_status,
	text = node.path,
	parent = parent,
	hidden = node.hidden,
	ignored = node.ignored,
	status = (not node.dir or not node.open or opts.git_status_open) and status or nil,
	last = true,
	type = node.type,
	severity = (not node.dir or not node.open or opts.diagnostics_open) and node.severity or nil,
	}
	if last[node.parent] then
	last[node.parent].last = false
	end
	last[node.parent] = item
	if top == node then
	item.hidden = false
	item.ignored = false
	end
	items[node.path] = item
	cb(item)
	end, { hidden = opts.hidden, ignored = opts.ignored, exclude = opts.exclude, include = opts.include })
	end
	end

I'd also like to know if it is possible, using options, to add a node called "Favorites" where you could add files using a keybind + custom action.

No, you will need to implement this by yourself.

If it is not possible, can I implement my own version of explorer ? If yes, where do I start from ?

There's no easy way to learn. You can try searching for something here: #1768 (comment)

[notfound4]

Thanks for the information ! I am looking into it and making good progress toward what i want. Thanks a lot !

I however, would also like to have a split side bar with explorer on top and symbols (trouble) on the bottom. Do you have any idea on how to achieve that ? Or should I ask on the Trouble github ?

And finally, do you know if it is possible to allow folding of the root folders (nodes without parent) ? Is it something I have to change in the finder function or somewhere else ?

Again thank you for your help and your time.

[drowning-cat]

I however, would also like to have a split side bar with explorer on top and symbols (trouble) on the bottom. Do you have any idea on how to achieve that ? Or should I ask on the Trouble github ?

You can try https://github.com/folke/edgy.nvim. But I'm not sure what the original problem is.

And finally, do you know if it is possible to allow folding of the root folders (nodes without parent) ? Is it something I have to change in the finder function or somewhere else ?

¯\(ツ)/¯

[notfound4]

Edgy looks like the thing I was looking for. Thank you.

[drowning-cat]

My dumb ass found a way to toggle the root directory:

snacks.nvim/lua/snacks/explorer/tree.lua

Line 237 in fe7cfe9

node.open = true

-- ...
          local top = Tree:find(dir)
          local top_open = top.open
          local last = {} ---@type table<snacks.picker.explorer.Node, snacks.picker.explorer.Item>
          Tree:get(dir, function(node)
            if node == top then
              node.open = top_open
            end
            if node ~= top and not top_open then
              return
            end
-- ...

[notfound4]

Sorry for my delayed response, I wanted to finish another project before getting back on it. I tried your solution and it worked !

However, I now have more questions. I tried to look into picker/init.lua, picker/core/picker.lua, explorer/init.lua and picker/source/explorer.lua but could not find my answers. My problem is that this custom explorer does not save the status of folders (expanded/collapsed) on close/resume and does not follow file.

I have difficulties understanding what part of snacks does these functions. Could you point me towards the files/functions that will help me correct this ?

Regarding the foldable root directories, I am trying to add an option to choose if they should be by default open or closed. The solution is probably simple but I have difficulties understanding some things, like when does the finder function is called ? Is it called each time a change is made (open/collapse folder) ? This will probably need to only trigger is no states are saved.

Anyway, thanks a lot for your time and advices.

[drowning-cat]

Follow the file:

snacks.nvim/lua/snacks/picker/source/explorer.lua

Line 47 in 7a90a08

Tree:open(buf_file)

snacks.nvim/lua/snacks/picker/source/explorer.lua

Line 113 in 7a90a08

if opts.follow_file then

The Tree is responsible for saving the open/closed state of entries:

snacks.nvim/lua/snacks/explorer/tree.lua

Lines 46 to 51 in 7a90a08

	function Tree.new()
	local self = setmetatable({}, Tree)
	self.root = { name = "", children = {}, dir = true, type = "directory", path = "" }
	self.nodes = {}
	return self
	end

The finder is triggered every time the tree changes. Try placing vim.print("+ " .. os.time()) inside it.

[drowning-cat]

It is the best you can get.

Some limitations come from the picker using a single Tree instance. This means that if you display two folders where one is nested inside the other, for example /home and /home/<user>, toggling /home/<user> will also open the same folder inside /home. I don't think this can be easily worked around, so it is a known issue.

---@module 'snacks'

local Tree = require("snacks.explorer.tree")

local tree_get = Tree.get
Tree.get = function(self, cwd, cb, opts)
  local cwd_node = Tree:find(cwd)
  local cwd_open = cwd_node.open
  tree_get(self, cwd, function(node)
    if node.path == cwd_node.path then
      node.open = cwd_open
    end
    if node.path ~= cwd_node.path and not cwd_open then
      return
    end
    cb(node)
  end, opts)
end

local cache_open = {}

local tree_toggle = function(path, open)
  if open == false or open == nil then
    Tree:close(path)
  else
    Tree:open(path)
  end
end

return {
  "folke/snacks.nvim",
  lazy = false,
  keys = {
    -- stylua: ignore
    { "<Leader>e", function() Snacks.picker.explorer() end, desc = "Open explorer" },
  },
  ---@type snacks.Config
  opts = {
    picker = {
      sources = {
        explorer = {
          dirs = { "/home", "/home/clover" },
          finder = function(opts, ctx)
            local find = require("snacks.picker.source.explorer").explorer(opts, ctx)
            local dirs = opts.dirs or { ctx:cwd() } ---@diagnostic disable-line
            return function(cb)
              for _, cwd in ipairs(dirs) do
                if not ctx.picker.shown then
                  tree_toggle(cwd, cache_open[cwd])
                end
                cache_open[cwd] = Tree:node(cwd).open
                ctx.picker:set_cwd(cwd)
                find(cb)
              end
            end
          end,
        },
      },
    },
  },
}