Awesome

xylene.nvim

For that one time where you need to explore your project's architecture

Semi WIP file tree plugin inspired by oil.nvim and carbon.nvim

xylene.nvim

Philosophy

Minimalism
Designed to be used with other FS plugins, I recommend oil.nvim
Fast, navigating should feel instant

Features

I want to preface that this file tree right now does not have plans to support file operations such as move/copy/rename ... etc

Navigating like a buffer
Subsequent empty directories are flattened into one line
Incremental rerendering of tree
Xylene! opens xylene with the current file already opened
Icons
Execute any code with files / directories (for example open currently hovering directory in oil.nvim)
Symlink support
Detect external file changes

Usage

While it's still missing some features listed above, I would be happy if you want to try it out

Install with your favorite package manager and call the setup function

Default options are listed below

require("xylene").setup({
  icons = {
    files = true,
    dir_open = "  ",
    dir_close = "  ",
  },
  keymaps = {
    enter = "<cr>",
  },
  indent = 4,
  sort_names = function(a, b)
    return a.name < b.name
  end,
  skip = function(name, filetype)
    return name == ".git"
  end,
  on_attach = function(renderer) end,
})

Keymaps

<cr> toggle dir / enter file

User commands

Xylene open a new xylene buffer with cwd as the root
Xylene! same as Xylene plus recursively opens directories to make your file seen

Recipes

Open currently hovering dir with oil.nvim

<details> <summary>video</summary>

https://github.com/user-attachments/assets/a66e005a-ce18-49ec-af07-8aeafe0873a6

</details>

require("xylene").setup({
  on_attach = function(renderer)
    vim.keymap.set("n", "<c-cr>", function()
      local row = vim.api.nvim_win_get_cursor(0)[1]

      local file = renderer:find_file(row)
      if not file then
        return
      end

      require("oil").open(file.path)
    end, { buffer = renderer.buf })
  end,
})

Search and open directory with telescope

<details> <summary>video</summary>

https://github.com/user-attachments/assets/d96fbe8f-625a-4105-bf0a-022e307e8acd

</details>

Right now a bit too much low level for my likings, I'll probably make this more concise in the future with new apis

require("xylene").setup({
  on_attach = function(renderer)
    vim.keymap.set("n", "<c-f>", function()
      local builtin = require("telescope.builtin")
      local action_state = require("telescope.actions.state")
      local actions = require("telescope.actions")

      builtin.find_files({
        find_command = { "fd", "-t", "d" },
        attach_mappings = function(_, map)
          map("i", "<cr>", function(prompt_bufnr)
            local entry = action_state.get_selected_entry()
            actions.close(prompt_bufnr)

            local path = vim.fs.joinpath(entry.cwd, entry[1])
            if path:sub(#path, #path) == "/" then
              -- remove trailing /
              path = path:sub(1, -2)
            end

            local utils = require("xylene.utils")

            --- find the file that will be rendered
            --- in this case the root file
            local root, root_row = nil, 0
            for _, f in ipairs(renderer.files) do
              root_row = root_row + 1

              if utils.string_starts_with(path, f.path) then
                root = f
                break
              end

              root_row = root_row + f.opened_count
            end

            local pre_from, pre_to = renderer:pre_render_file(root, root_row)

            local file, line = renderer:open_from_filepath(path)
            if not file then
              return
            end

            file:open()
            renderer:render_file(root, pre_from, pre_to)

            vim.api.nvim_win_set_cursor(0, { line, file:indent_len() })
          end)

          return true
        end,
      })
    end, { buffer = renderer.buf })

  end
})

API

xylene.File

todo

xylene.Renderer

todo

xylene.Config

todo