feat: add option to hide root dir path

README.md

@@ -58,10 +58,12 @@ require'nvim-tree'.setup {
   },
   -- hijack the cursor in the tree to put it at the start of the filename
   hijack_cursor       = false,
-  -- updates the root directory of the tree on `DirChanged` (when your run `:cd` usually) 
+  -- updates the root directory of the tree on `DirChanged` (when your run `:cd` usually)
   update_cwd          = false,
   -- show lsp diagnostics in the signcolumn
   lsp_diagnostics     = false,
+  -- Hide the root path of the current folder on top of the tree
+  hide_root_folder    = false,
   -- update the focused file on `BufEnter`, un-collapses the folders recursively until it finds the file
   update_focused_file = {
     -- enables the feature
@@ -222,6 +224,7 @@ highlight NvimTreeFolderIcon guibg=blue
 ### Settings
 
 The `list` option in `view.mappings.list` is a table of
+
 ```lua
 -- key can be either a string or a table of string (lhs)
 -- cb is the callback that will be called
@@ -232,6 +235,7 @@ local list = {
 ```
 
 These are the default bindings:
+
 ```lua
 local tree_cb = require'nvim-tree.config'.nvim_tree_callback
 -- default mappings

doc/nvim-tree-lua.txt

@@ -78,6 +78,7 @@ function.
       open_on_tab         = false,
       hijack_cursor       = false,
       update_cwd          = false,
+			hide_root_folder		= false,
       lsp_diagnostics     = false,
       update_focused_file = {
         enable      = false,
@@ -200,7 +201,10 @@ Here is a list of the options available in the setup call:
     type: `boolean`
     default: false
 
-*nvim-tree.view*
+- |hide_root_folder|: hide the path of the current working directory on top of the tree
+		type: `boolean`
+		default: false
+
 - |view|: window / buffer setup
 
   - |view.width|: width of the window, can be either a `%` string or
@@ -547,6 +551,7 @@ applied.
 
 NvimTreeSymlink
 NvimTreeFolderName
+NvimTreeHideRootFolder
 NvimTreeRootFolder
 NvimTreeFolderIcon
 NvimTreeEmptyFolderName

lua/nvim-tree.lua

@@ -161,8 +161,15 @@ function M.on_keypress(mode)
     return keypress_funcs[mode](node)
   end
 
+	local hide_root_folder = view.View.hide_root_folder
+
+
   if node.name == ".." then
-    return lib.change_dir("..")
+		if hide_root_folder then
+			return lib.unroll_dir(node);
+		else
+			return lib.change_dir("..")
+		end
   elseif mode == "cd" and node.entries ~= nil then
     return lib.change_dir(lib.get_last_group_node(node).absolute_path)
   elseif mode == "cd" then
@@ -408,7 +415,8 @@ local DEFAULT_OPTS = {
   hijack_cursor       = false,
   update_cwd          = false,
   lsp_diagnostics     = false,
-  update_focused_file = {
+  hide_root_folder		= false,
+	update_focused_file = {
     enable = false,
     update_cwd = false,
     ignore_list = {}
@@ -439,6 +447,10 @@ function M.setup(conf)
     _config.update_to_buf_dir = opts.update_to_buf_dir
   end
 
+	if opts.hide_root_folder then
+		view.View.hide_root_folder = true
+	end
+
   require'nvim-tree.colors'.setup()
   require'nvim-tree.view'.setup(opts.view or {})
   require'nvim-tree.diagnostics'.setup(opts)
@@ -450,4 +462,37 @@ function M.setup(conf)
   vim.schedule(function() M.on_enter(opts) end)
 end
 
+local function startup_check_new_setup()
+  local out_config = {
+    "nvim_tree_disable_netrw",
+    "nvim_tree_hijack_netrw",
+    "nvim_tree_auto_open",
+    "nvim_tree_auto_close",
+    "nvim_tree_tab_open",
+		"nvim_tree_hide_root_folder",
+		"nvim_tree_update_cwd",
+    "nvim_tree_hijack_cursor",
+    "nvim_tree_system_open_command",
+    "nvim_tree_system_open_command_args",
+    "nvim_tree_follow",
+    "nvim_tree_follow_update_path",
+    "nvim_tree_lsp_diagnostics",
+    "nvim_tree_auto_resize",
+    "nvim_tree_bindings",
+    "nvim_tree_disable_keybindings",
+    "nvim_tree_disable_default_keybindings",
+  }
+
+  local x = vim.tbl_filter(function(v)
+    return vim.fn.exists('g:'..v) ~= 0
+  end, out_config)
+
+  if #x > 0 then
+    local msg = "following options are now set in the setup, please read the new documentation for the setup function: "
+    require'nvim-tree.utils'.echo_warning(msg..table.concat(x, " | "))
+  end
+end
+
+vim.defer_fn(startup_check_new_setup, 1000)
+
 return M

lua/nvim-tree/lib.lua

@@ -60,6 +60,12 @@ end
 
 local function get_node_at_line(line)
   local index = 2
+
+	local hide_root_folder = view.View.hide_root_folder
+	if hide_root_folder then
+		index = 1
+	end
+
   local function iter(entries)
     for _, node in ipairs(entries) do
       if index == line then
@@ -102,6 +108,7 @@ end
 
 function M.get_node_at_cursor()
   local winnr = view.get_winnr()
+	local hide_root_folder = view.View.hide_root_folder
   if not winnr then
     return
   end
@@ -112,7 +119,7 @@ function M.get_node_at_cursor()
     local help_text = get_node_at_line(line+1)(help_lines)
     return {name = help_text}
   else
-    if line == 1 and M.Tree.cwd ~= "/" then
+    if line == 1 and M.Tree.cwd ~= "/" and not hide_root_folder then
       return { name = ".." }
     end
 
@@ -205,7 +212,8 @@ end
 
 function M.set_index_and_redraw(fname)
   local i
-  if M.Tree.cwd == '/' then
+	local hide_root_folder = view.View.hide_root_folder
+  if M.Tree.cwd == '/' and hide_root_folder then
     i = 0
   else
     i = 1

lua/nvim-tree/renderer/init.lua

@@ -251,14 +251,17 @@ local picture = {
 
 local function update_draw_data(tree, depth, markers)
   local root_folder_modifier = vim.g.nvim_tree_root_folder_modifier or ':~'
-  local special = vim.g.nvim_tree_special_files or {
+	local special = vim.g.nvim_tree_special_files or {
     ["Cargo.toml"] = true,
     Makefile = true,
     ["README.md"] = true,
     ["readme.md"] = true,
   }
 
-  if tree.cwd and tree.cwd ~= '/' then
+
+  local hide_root_folder = view.View.hide_root_folder
+
+  if tree.cwd and tree.cwd ~= '/' and not hide_root_folder then
     local root_name = utils.path_join({
       utils.path_remove_trailing(vim.fn.fnamemodify(tree.cwd, root_folder_modifier)),
       ".."

lua/nvim-tree/view.lua

@@ -9,6 +9,7 @@ end
 M.View = {
   bufnr = nil,
   tabpages = {},
+	hide_root_folder = false,
   winopts = {
     relativenumber = false,
     number = false,
@@ -107,7 +108,7 @@ end
 local DEFAULT_CONFIG = {
   width = 30,
   side = 'left',
-  auto_resize = false,
+	auto_resize = false,
   mappings = {
     custom_only = false,
     list = {}
@@ -141,7 +142,7 @@ function M.setup(opts)
   local options = vim.tbl_deep_extend('force', DEFAULT_CONFIG, opts)
   M.View.side = options.side
   M.View.width = options.width
-  M.View.auto_resize = opts.auto_resize
+	M.View.auto_resize = opts.auto_resize
   if options.mappings.custom_only then
     M.View.mappings = options.mappings.list
   else