Open Nvim-Tree with multiple options

[daUnknownCoder]

Right Now, im editing my config, and wanted to know real quick, if i can use a few opts from Nvim-Tree's wiki of Open On Startup?
rn, i want these:
No name Buffers
Open for current/new window

so what i want to use is a single open_nvim_tree(data) function instead of NvimTreeFindFileToggle

current config:

return {
  {
    "nvim-tree/nvim-tree.lua",
    cmd = "NvimTreeFindFileToggle",
    lazy = false,
    keys = {
      { "<C-n>", "<cmd>NvimTreeFindFileToggle<cr>", desc = "NvimTree" },
      { "<leader>f", "<cmd>lua require('treeutils').launch_find_files()<cr>", desc = "NvimTree Find Files" },
      { "<leader>g", "<cmd>lua require('treeutils').launch_live_grep()<cr>", desc = "NvimTree Live Grep" },
      { ";g", "<cmd>lua require('treeutils').stage_file()<cr>", desc = "NvimTree Stage File" },
    },
    event = "VeryLazy",
    config = function()
      local nvimtree_status_ok, nvimtree = pcall(require, "nvim-tree")
      if not nvimtree_status_ok then
        print("NvimTree not found!")
      end
      local icons_ok, icons = pcall(require, "NeutronVim.core.icons")
      if not icons_ok then
        print("Unable to import icons!")
      end

      vim.opt.termguicolors = true

      local HEIGHT_RATIO = 0.8
      local WIDTH_RATIO = 0.8

      nvimtree.setup({
        filters = { custom = { "*.tmp", "*.git" } },
        disable_netrw = true,
        hijack_netrw = true,
        respect_buf_cwd = true,
        update_focused_file = {
          enable = true,
          update_cwd = true,
        },
        hijack_cursor = true,
        update_cwd = true,
        view = {
          relativenumber = true,
          float = {
            enable = true,
            open_win_config = function()
              local screen_w = vim.opt.columns:get()
              local screen_h = vim.opt.lines:get() - vim.opt.cmdheight:get()
              local window_w = screen_w * WIDTH_RATIO
              local window_h = screen_h * HEIGHT_RATIO
              local window_w_int = math.floor(window_w)
              local window_h_int = math.floor(window_h)
              local center_x = (screen_w - window_w) / 2
              local center_y = ((vim.opt.lines:get() - window_h) / 2) - vim.opt.cmdheight:get()
              return {
                border = "rounded",
                relative = "editor",
                row = center_y,
                col = center_x,
                width = window_w_int,
                height = window_h_int,
              }
            end,
          },
          width = function()
            return math.floor(vim.opt.columns:get() * WIDTH_RATIO)
          end,
        },
        renderer = {
          indent_markers = {
            enable = true,
            inline_arrows = true,
            icons = {
              corner = icons.ui.Corner,
              edge = icons.ui.Edge,
              item = icons.ui.Item,
              bottom = icons.ui.Bottom,
              none = icons.ui.None,
            },
          },
          highlight_modified = "all",
          icons = {
            glyphs = {
              folder = {
                arrow_closed = icons.ui.ArrowClosed,
                arrow_open = icons.ui.ArrowOpen,
              },
            },
            webdev_colors = true,
            git_placement = "before",
            modified_placement = "after",
            padding = " ",
            symlink_arrow = icons.ui.Arrow,
            show = {
              file = true,
              folder = true,
              folder_arrow = true,
              git = true,
              modified = true,
            },
          },
        },
        modified = {
          enable = true,
          show_on_dirs = true,
        },
        diagnostics = {
          enable = true,
          show_on_open_dirs = true,
          icons = {
            hint = icons.diagnostics.Hint,
            info = icons.diagnostics.Info,
            warning = icons.diagnostics.Warning,
            error = icons.diagnostics.Error,
          },
        },
      })
      local tree_api = require("nvim-tree")
      local tree_view = require("nvim-tree.view")

      vim.api.nvim_create_augroup("NvimTreeResize", {
        clear = true,
      })

      vim.api.nvim_create_autocmd({ "VimResized" }, {
        group = "NvimTreeResize",
        callback = function()
          if tree_view.is_visible() then
            tree_view.close()
            tree_api.open()
          end
        end,
      })
    end,
  },
}

treeutils.lua

local api = require("nvim-tree.api")
local openfile = require("nvim-tree.actions.node.open-file")
local actions = require("telescope.actions")
local action_state = require("telescope.actions.state")
local M = {}

local view_selection = function(prompt_bufnr, map)
  actions.select_default:replace(function()
    actions.close(prompt_bufnr)
    local selection = action_state.get_selected_entry()
    local filename = selection.filename
    if filename == nil then
      filename = selection[1]
    end
    openfile.fn("preview", filename)
  end)
  return true
end

function M.launch_live_grep(opts)
  return M.launch_telescope("live_grep", opts)
end

function M.launch_find_files(opts)
  return M.launch_telescope("find_files", opts)
end

function M.launch_telescope(func_name, opts)
  local telescope_status_ok, _ = pcall(require, "telescope")
  if not telescope_status_ok then
    return
  end
  local node = api.tree.get_node_under_cursor()
  local is_folder = node.fs_stat and node.fs_stat.type == "directory" or false
  local basedir = is_folder and node.absolute_path or vim.fn.fnamemodify(node.absolute_path, ":h")
  if node.name == ".." and TreeExplorer ~= nil then
    basedir = TreeExplorer.cwd
  end
  opts = opts or {}
  opts.cwd = basedir
  opts.search_dirs = { basedir }
  opts.attach_mappings = view_selection
  return require("telescope.builtin")[func_name](opts)
end

function M.stage_file()
  local node = api.tree.get_node_under_cursor()
  local gs = node.git_status.file

  -- If the current node is a directory get children status
  if gs == nil then
    gs = (node.git_status.dir.direct ~= nil and node.git_status.dir.direct[1])
      or (node.git_status.dir.indirect ~= nil and node.git_status.dir.indirect[1])
  end

  -- If the file is untracked, unstaged or partially staged, we stage it
  if gs == "??" or gs == "MM" or gs == "AM" or gs == " M" then
    vim.cmd("silent !git add " .. node.absolute_path)

  -- If the file is staged, we unstage
  elseif gs == "M " or gs == "A " then
    vim.cmd("silent !git restore --staged " .. node.absolute_path)
  end

  api.tree.reload()
end

function M.open_nvim_tree(data)
  -- buffer is a real file on the disk
  local real_file = vim.fn.filereadable(data.file) == 1

  -- buffer is a [No Name]
  local no_name = data.file == "" and vim.bo[data.buf].buftype == ""

  if not real_file and not no_name then
    return
  end

  -- open the tree, find the file but don't focus it
  require("nvim-tree.api").tree.toggle({ focus = false, find_file = true })
end

return M

[alex-courtis]

so what i want to use is a single open_nvim_tree(data) function instead of NvimTreeFindFileToggle

You can definitely do this - using API is preferable to a command as it allows you to specify the behaviour you need.

Your configuration looks very rich and well thought out and your open_nvim_tree function looks like it can achieve your desired functionality.

What exactly is not working?

local tree_view = require("nvim-tree.view")
local openfile = require("nvim-tree.actions.node.open-file")

These modules are not API and should not be used as they are internal and subject to change at any time.

Please use :help nvim-tree-api.tree.is_visible() and :help nvim-tree-api.node.open.preview()

Take a look at :help nvim-tree-api and :help nvim-tree-index-api to see all the functionality available. New API can always be added upon request.

[daUnknownCoder]

Your configuration looks very rich and well thought out and your open_nvim_tree function looks like it can achieve your desired functionality.

its my neovim distro, which i plan to publicize once there are some startup improvements: https://github.com/daUnknownCoder/NeutronVim

i am not really great at lua, but i try my best to learn this language

What exactly is not working?

idk how to put this, but i dont really know how to do it, so if you can it will be great,

after i saw the wiki section coz i was bored with life, i saw this and i was amazed, but if only i could luafy it...

i reaaly wanna replace the NvimTreeFindFileToggle function with the open_nvim_tree() function and use the predefined one if at all the user explicitly wants to, so this is the thing i wanna do:

treeutils.lua

local api = require("nvim-tree.api")
local openfile = require("nvim-tree.actions.node.open-file")
local actions = require("telescope.actions")
local action_state = require("telescope.actions.state")
local M = {}

local view_selection = function(prompt_bufnr, map)
  actions.select_default:replace(function()
    actions.close(prompt_bufnr)
    local selection = action_state.get_selected_entry()
    local filename = selection.filename
    if filename == nil then
      filename = selection[1]
    end
    openfile.fn("preview", filename)
  end)
  return true
end

function M.launch_live_grep(opts)
  return M.launch_telescope("live_grep", opts)
end

function M.launch_find_files(opts)
  return M.launch_telescope("find_files", opts)
end

function M.launch_telescope(func_name, opts)
  local telescope_status_ok, _ = pcall(require, "telescope")
  if not telescope_status_ok then
    return
  end
  local node = api.tree.get_node_under_cursor()
  local is_folder = node.fs_stat and node.fs_stat.type == "directory" or false
  local basedir = is_folder and node.absolute_path or vim.fn.fnamemodify(node.absolute_path, ":h")
  if node.name == ".." and TreeExplorer ~= nil then
    basedir = TreeExplorer.cwd
  end
  opts = opts or {}
  opts.cwd = basedir
  opts.search_dirs = { basedir }
  opts.attach_mappings = view_selection
  return require("telescope.builtin")[func_name](opts)
end

function M.stage_file()
  local node = api.tree.get_node_under_cursor()
  local gs = node.git_status.file

  -- If the current node is a directory get children status
  if gs == nil then
    gs = (node.git_status.dir.direct ~= nil and node.git_status.dir.direct[1])
      or (node.git_status.dir.indirect ~= nil and node.git_status.dir.indirect[1])
  end

  -- If the file is untracked, unstaged or partially staged, we stage it
  if gs == "??" or gs == "MM" or gs == "AM" or gs == " M" then
    vim.cmd("silent !git add " .. node.absolute_path)

  -- If the file is staged, we unstage
  elseif gs == "M " or gs == "A " then
    vim.cmd("silent !git restore --staged " .. node.absolute_path)
  end

  api.tree.reload()
end

function M.open_nvim_tree(data)
  -- buffer is a real file on the disk
  local real_file = vim.fn.filereadable(data.file) == 1

  -- buffer is a [No Name]
  local no_name = data.file == "" and vim.bo[data.buf].buftype == ""

  if not real_file and not no_name then
    return
  end

  -- open the tree, find the file but don't focus it
  require("nvim-tree.api").tree.toggle({ focus = false, find_file = true })
end

return M

this was all copied from all over the wiki

i want to add this:

local function open_nvim_tree(data)

  -- buffer is a real file on the disk
  local real_file = vim.fn.filereadable(data.file) == 1

  -- buffer is a [No Name]
  local no_name = data.file == "" and vim.bo[data.buf].buftype == ""

  if not real_file and not no_name then
    return
  end

  -- open the tree, find the file but don't focus it
  require("nvim-tree.api").tree.toggle({ focus = false, find_file = true, })
end

and any1 of the below two idk whats the diff or maybe both of them (current/ new window)

local function open_nvim_tree(data)

  -- buffer is a directory
  local directory = vim.fn.isdirectory(data.file) == 1

  if not directory then
    return
  end

  -- change to the directory
  vim.cmd.cd(data.file)

  -- open the tree
  require("nvim-tree.api").tree.open()
end

or

local function open_nvim_tree(data)

  -- buffer is a directory
  local directory = vim.fn.isdirectory(data.file) == 1

  if not directory then
    return
  end

  -- create a new, empty buffer
  vim.cmd.enew()

  -- wipe the directory buffer
  vim.cmd.bw(data.buf)

  -- change to the directory
  vim.cmd.cd(data.file)

  -- open the tree
  require("nvim-tree.api").tree.open()
end

i might have also tried a few times, but i always fail at the return M coz i dont understand it

[alex-courtis]

its my neovim distro, which i plan to publicize once there are some startup improvements: https://github.com/daUnknownCoder/NeutronVim

i am not really great at lua, but i try my best to learn this language

Well, if you're producing a neovim distribution you'll need to Get Good ;)

I suggest Programming in Lua (free, online) by the author of the language, Roberto.

idk how to put this, but i dont really know how to do it, so if you can it will be great,

Start with nothing and build just one piece at a time:

Start with only, say, a standalone open open_nvim_tree and ensure you can execute it.

Enhance it to add data for a VimEnter, which I presume is what you are doing.

Add all your nvim-tree setup options.

Add telescope, git handlers etc. etc.

[alex-courtis]

"NeutronVim is very lightweight, currently has only 3015 loc of lua code..."

Nit:
"NeutronVim is very lightweight, currently has only 3015 lines of lua code..." or
"NeutronVim is very lightweight, currently has only 3015 loc..."