Migration guide

[kyazdani42]

nvim-tree.lua once used global variables to define options. These have been moved into setup options.

• g:nvim_tree_disable_netrw -> disable_netrw
• g:nvim_tree_hijack_netrw -> hijack_netrw
• g:nvim_tree_auto_open -> open_on_setup
• g:nvim_tree_tab_open -> open_on_tab
• g:nvim_tree_update_cwd -> update_cwd
• g:nvim_tree_hijack_cursor -> hijack_cursor
• g:nvim_tree_system_open_command -> system_open.cmd
• g:nvim_tree_system_open_command_args -> system_open.args
• g:nvim_tree_follow -> update_focused_file.enable
• g:nvim_tree_follow_update_path -> update_focused_file.update_cwd
• g:nvim_tree_lsp_diagnostics -> lsp_diagnostics
• g:nvim_tree_auto_resize -> actions.open_file.resize_window
• g:nvim_tree_bindings -> view.mappings.list
• g:nvim_tree_hide_dotfiles -> filters.dotfiles
• g:nvim_tree_ignore -> filters.custom
• g:nvim_tree_gitignore -> git.ignore
• g:nvim_tree_disable_window_picker -> actions.open_file.window_picker.enable
• g:nvim_tree_window_picker_chars -> actions.open_file.window_picker.chars
• g:nvim_tree_window_picker_exclude -> actions.open_file.window_picker.exclude
• g:nvim_tree_change_dir_global -> actions.change_dir.global
• g:nvim_tree_quit_on_open -> actions.open_file.quit_on_open
• g:nvim_tree_indent_markers -> renderer.indent_markers.enable
• g:nvim_tree_add_trailing -> renderer.add_trailing
• g:nvim_tree_highlight_opened_files -> renderer.highlight_opened_files
  • 0 -> "none"
  • 1 -> "icon"
  • 2 -> "name"
  • 3 -> "all"
• g:nvim_tree_root_folder_modifier -> renderer.root_folder_modifier
• g:nvim_tree_special_files -> renderer.special_files
• g:nvim_tree_icon_padding -> renderer.icons.padding
• g:nvim_tree_symlink_arrow -> renderer.icons.symlink_arrow
• g:nvim_tree_show_icons -> renderer.icons.show
  • files -> file
  • folders ->folder
  • folder_arrows -> folder_arrow
• g:nvim_tree_icons -> renderer.icons.glyphs
• g:nvim_tree_git_hl -> renderer.highlight_git
• g:nvim_tree_group_empty -> renderer.group_empty
• g:nvim_tree_respect_buf_cwd -> respect_buf_cwd
• g:nvim_tree_create_in_closed_folder -> create_in_closed_folder

g:auto_close feature was removed. See readme.

g:nvim_tree_disable_keybindings and g:nvim_tree_disable_default_keybindings have been replaced by using view.mappings.custom_only.
Setting view.mappings.custom_only to true and view.mappings.list to {} would do the same as g:nvim_tree_disable_keybindings and view.mappings.custom_only to true with your list of keybindings would do the same as nvim_tree_disable_default_keybindings.

[wookayin]

Please pin this or add a link to README! I was just surprised to find these options are gone.

[JarnoB]

Thanks, this is helpful!
But isn't nvim_tree_tab_open -> tab_open supposed to be nvim_tree_tab_open -> open_on_tab?

[kyazdani42]

good catch !

[k1nxx]

Auto open doesn't work btw!

config

require'nvim-tree'.setup {
open_on_setup       = true,
}

[kyazdani42]

exactly like described in the guide 😄

[ismikhail]

The view config does not seem to be working for me.
I installed the plugin with Packer like this:

  use {
    'kyazdani42/nvim-tree.lua',
    requires = 'kyazdani42/nvim-web-devicons'
  }

Then use this setup

require'nvim-tree'.setup {
  auto_close = true,
  view = {
    side = 'right',
    width = 70
  }
}

The auto_close setting works but the view does not have any effect.

[nshen]

The view config does not seem to be working for me. I installed the plugin with Packer like this:

  use {
    'kyazdani42/nvim-tree.lua',
    requires = 'kyazdani42/nvim-web-devicons'
  }

Then use this setup

require'nvim-tree'.setup {
  auto_close = true,
  view = {
    side = 'right',
    width = 70
  }
}

The auto_close setting works but the view does not have any effect.

same here. I can't set width, in either way.

[Olyve]

Just to chime in here, I am also unable to get the width set using the above two comments method in the setup method.

[b0o]

It would be nice if you added a link to this issue inside the deprecation warning messages. If you think the URL is too long, you could use GitHub's git.io URL shortener, e.g. git.io/JPhyt. Alternatively, you could add this information to nvim-tree-lua.txt.

[kyazdani42]

@ismikhail @nshen @sgalizia i cannot reproduce, could you open a new issue if this is still happening to you please ?

[AlvaroPata]

Hi! Is there a reason why I still get this warning even with the default configuration?

[alex-courtis]

Hi! Is there a reason why I still get this warning even with the default configuration?

Are you receiving

1. "Following options were moved to setup..." warning
2. "unknown/invalid option".

For 2, please see #1334

1 indicates that you have global g: variabled defined somewhere.

[AlvaroPata]

Thanks! I found some g. settings i had forgotten about!

[nobody4t]

I can not understand here. I use the latest version and I got the warning each time I open nvim. Should I do some manually work here?

[kyazdani42]

You might have some g:nvim_tree... options left. What does the warning print ?

[nobody4t]

@kyazdani42
Thanks for your reply. I have resolved this. I need to modify my config accordingly.