Refacto: rewrite everything

- The tree is created with libuv functions, which makes it blazingly fast.
- The tree may now be faster than any other vim trees, it can handle directories with thousands of files without any latency at all (tested on 40K files, works flawlessly).
- More solid logic for opening and closing the tree.
- tree state is remembered (closing / opening a folder keeps opened subdirectories open)
- detection of multiple git projects in the tree
- more icon support
- smart rendering
- smart updates
- ms windows support
- gx replacement function running xdg-open on linux, open on macos

Author: kyazdani42

README.md

@@ -2,12 +2,13 @@
 
 ## Notice
 
-- This plugin does not work on windows.
+This plugin doesn't support windows
 
 ## Install
 
 Install with [vim-plug](https://github.com/junegunn/vim-plug):
 ```vim
+Plug 'kyazdani42/nvim-web-devicons' " for file icons
 Plug 'kyazdani42/nvim-tree.lua'
 ```
 
@@ -16,19 +17,18 @@ Plug 'kyazdani42/nvim-tree.lua'
 ```vim
 let g:lua_tree_side = 'right' | 'left' "left by default
 let g:lua_tree_size = 40 "30 by default
-let g:lua_tree_ignore = [ '.git', 'node_modules', '.cache' ] "empty by default, not working on mac atm
+let g:lua_tree_ignore = [ '.git', 'node_modules', '.cache' ] "empty by default
 let g:lua_tree_auto_open = 1 "0 by default, opens the tree when typing `vim $DIR` or `vim`
 let g:lua_tree_auto_close = 1 "0 by default, closes the tree when it's the last window
-let g:lua_tree_follow = 1 "0 by default, this option will bind BufEnter to the LuaTreeFindFile command
-" :help LuaTreeFindFile for more info
+let g:lua_tree_follow = 1 "0 by default, this option allows the cursor to be updated when entering a buffer
 let g:lua_tree_show_icons = {
     \ 'git': 1,
     \ 'folders': 0,
     \ 'files': 0,
     \}
 "If 0, do not show the icons for one of 'git' 'folder' and 'files'
 "1 by default, notice that if 'files' is 1, it will only display
-"if web-devicons is installed and on your runtimepath
+"if nvim-web-devicons is installed and on your runtimepath
 
 " You can edit keybindings be defining this variable
 " You don't have to define all keys.
@@ -44,14 +44,17 @@ let g:lua_tree_bindings = {
     \ 'rename':      'r'
     \ }
 
+let g:lua_tree_icons = {
+    \
+    \ }
+
 nnoremap <C-n> :LuaTreeToggle<CR>
 nnoremap <leader>r :LuaTreeRefresh<CR>
 nnoremap <leader>n :LuaTreeFindFile<CR>
 
 set termguicolors " this variable must be enabled for colors to be applied properly
 
 " a list of groups can be found at `:help lua_tree_highlight`
-highlight LuaTreeFolderName guibg=cyan gui=bold,underline
 highlight LuaTreeFolderIcon guibg=blue
 ```
 
@@ -60,7 +63,8 @@ highlight LuaTreeFolderIcon guibg=blue
 - move around like in any vim buffer
 - `<CR>` on `..` will cd in the above directory
 - `.` will cd in the directory under the cursor
-- type `a` to add a file
+- type `a` to add a file. Adding a directory requires leaving a leading `/` at the end of the path.
+> you can add multiple directories by doing foo/bar/baz/f and it will add foo bar and baz directories and f as a file
 - type `r` to rename a file
 - type `d` to delete a file (will prompt for confirmation)
 - if the file is a directory, `<CR>` will open the directory
@@ -72,21 +76,20 @@ highlight LuaTreeFolderIcon guibg=blue
 - Double left click acts like `<CR>`
 - Double right click acts like `.`
 
+## Note
+
+This plugin is very fast. It has been tested on 40K items which opens instantly. \
+The performance of that plugin is due to the use of the `libuv` `scandir` and `scandir_next` functions instead of spawning an `ls` process which can get slow on large files when combining with `stat` to get file informations.
+
 ## Features
-- [x] Open file in current buffer or in split with FzF like bindings (`<CR>`, `<C-v>`, `<C-x>`, `<C-t>`)
-- [x] File icons with vim-devicons
-- [x] Syntax highlighting ([exa](https://github.com/ogham/exa) like)
-- [x] Change directory with `.`
-- [x] Add / Rename / delete files
-- [x] Git integration
-- [x] Mouse support
+- Open file in current buffer or in split with FzF like bindings (`<CR>`, `<C-v>`, `<C-x>`, `<C-t>`)
+- File icons with vim-devicons
+- Syntax highlighting ([exa](https://github.com/ogham/exa) like)
+- Change directory with `.`
+- Add / Rename / delete files
+- Git integration
+- Mouse support
 
 ## Screenshot
 
 ![alt text](.github/screenshot.png?raw=true "file explorer")
-
-## TODO
-
-- Tree creation could be async
-- bufferize tree
-- better default colors (use vim highlight groups)

doc/nvim-tree-lua.txt

@@ -19,6 +19,14 @@ open the tree with :LuaTreeToggle
 ==============================================================================
 COMMANDS                                           *nvim-tree-commands*
 
+|:LuaTreeOpen| 	                                  *:LuaTreeOpen*
+
+opens the tree
+
+|:LuaTreeClose| 	                          *:LuaTreeClose*
+
+closes the tree
+
 |:LuaTreeToggle| 	                          *:LuaTreeToggle*
 
 open or close the tree
@@ -32,7 +40,8 @@ refresh the tree
 The command will change the cursor in the tree for the current bufname.
 
 It will also open the leafs of the tree leading to the file in the buffer 
-(if you opened a file with something else than the LuaTree, like `fzf`)
+(if you opened a file with something else than the LuaTree, like `fzf` or
+`:split`)
 
 ==============================================================================
 OPTIONS				                  *nvim-tree-options*
@@ -130,8 +139,7 @@ default keybindings will be applied to undefined keys.
 File icons with vim-devicons.
 
 Uses other type of icons so a good font support is recommended.
-If the tree renders weird glyphs, install correct fonts or try to change
-your terminal.
+If the tree renders weird glyphs, install the correct fonts.
 
 Syntax highlighting uses g:terminal_color_ from colorschemes, fallbacks to
 ugly colors otherwise.

lua/lib/colors.lua

@@ -1,27 +1,56 @@
 local api = vim.api
-local get_colors = require 'lib/config'.get_colors
-
-local colors = get_colors()
 
 local M = {}
 
-local function create_hl() 
+local function get_color_from_hl(hl_name, fallback)
+  local id = vim.api.nvim_get_hl_id_by_name(hl_name)
+  if not id then return fallback end
+
+  local hl = vim.api.nvim_get_hl_by_id(id, true)
+  if not hl or not hl.foreground then return fallback end
+
+  return hl.foreground
+end
+
+local function get_colors()
+  return {
+    red      = vim.g.terminal_color_1  or get_color_from_hl('Keyword', 'Red'),
+    green    = vim.g.terminal_color_2  or get_color_from_hl('Character', 'Green'),
+    yellow   = vim.g.terminal_color_3  or get_color_from_hl('PreProc', 'Yellow'),
+    blue     = vim.g.terminal_color_4  or get_color_from_hl('Include', 'Blue'),
+    purple   = vim.g.terminal_color_5  or get_color_from_hl('Define', 'Purple'),
+    cyan     = vim.g.terminal_color_6  or get_color_from_hl('Conditional', 'Cyan'),
+    dark_red = vim.g.terminal_color_9  or get_color_from_hl('Keyword', 'DarkRed'),
+    orange   = vim.g.terminal_color_11 or get_color_from_hl('Number', 'Orange'),
+  }
+end
+
+local function get_hl_groups() 
+  local colors = get_colors()
+
   return {
     Symlink = { gui = 'bold', fg = colors.cyan },
-    FolderName = { gui = 'bold', fg = colors.blue },
     FolderIcon = { fg = '#90a4ae' },
 
     ExecFile = { gui = 'bold', fg = colors.green },
     SpecialFile = { gui = 'bold,underline', fg = colors.yellow },
     ImageFile = { gui = 'bold', fg = colors.purple },
-    MarkdownFile = { fg = colors.purple },
+
+    GitDirty = { fg = colors.dark_red },
+    GitStaged = { fg = colors.green },
+    GitMerge = { fg = colors.orange },
+    GitRenamed = { fg = colors.purple },
+    GitNew = { fg = colors.yellow },
+
+    -- TODO: remove those when we add this to nvim-web-devicons
+    MarkdownIcon = { fg = colors.purple },
     LicenseIcon = { fg = colors.yellow },
     YamlIcon = { fg = colors.yellow },
     TomlIcon = { fg = colors.yellow },
     GitignoreIcon = { fg = colors.yellow },
     JsonIcon = { fg = colors.yellow },
-
     LuaIcon = { fg = '#42a5f5' },
+    GoIcon = { fg = '#7Fd5EA' },
     PythonIcon = { fg = colors.green },
     ShellIcon = { fg = colors.green },
     JavascriptIcon = { fg = colors.yellow },
@@ -31,34 +60,62 @@ local function create_hl()
     RustIcon = { fg = colors.orange },
     VimIcon = { fg = colors.green },
     TypescriptIcon = { fg = colors.blue },
-
-    GitDirty = { fg = colors.dark_red },
-    GitStaged = { fg = colors.green },
-    GitMerge = { fg = colors.orange },
-    GitRenamed = { fg = colors.purple },
-    GitNew = { fg = colors.yellow }
   }
 end
 
-local HIGHLIGHTS = create_hl()
-
-local LINKS = {
-  Normal = 'Normal',
-  EndOfBuffer = 'EndOfBuffer',
-  CursorLine = 'CursorLine',
-  VertSplit = 'VertSplit',
-  CursorColumn = 'CursorColumn'
+-- TODO: remove those when we add this to nvim-web-devicons
+M.hl_groups = {
+  ['LICENSE'] = 'LicenseIcon';
+  ['license'] = 'LicenseIcon';
+  ['vim'] = 'VimIcon';
+  ['.vimrc'] = 'VimIcon';
+  ['c'] = 'CIcon';
+  ['cpp'] = 'CIcon';
+  ['python'] = 'PythonIcon';
+  ['lua'] = 'LuaIcon';
+  ['rs'] = 'RustIcon';
+  ['sh'] = 'ShellIcon';
+  ['csh'] = 'ShellIcon';
+  ['zsh'] = 'ShellIcon';
+  ['bash'] = 'ShellIcon';
+  ['md'] = 'MarkdownIcon';
+  ['json'] = 'JsonIcon';
+  ['toml'] = 'TomlIcon';
+  ['go'] = 'GoIcon';
+  ['yaml'] = 'YamlIcon';
+  ['yml'] = 'YamlIcon';
+  ['conf'] = 'GitignoreIcon';
+  ['javascript'] = 'JavascriptIcon';
+  ['typescript'] = 'TypescriptIcon';
+  ['jsx'] = 'ReactIcon';
+  ['tsx'] = 'ReactIcon';
+  ['htm'] = 'HtmlIcon';
+  ['html'] = 'HtmlIcon';
+  ['slim'] = 'HtmlIcon';
+  ['haml'] = 'HtmlIcon';
+  ['ejs'] = 'HtmlIcon';
 }
 
-function M.init_colors()
-  colors = get_colors()
-  HIGHLIGHTS = create_hl()
-  for k, d in pairs(HIGHLIGHTS) do
+local function get_links() 
+  return {
+    FolderName = 'Directory',
+    Normal = 'Normal',
+    EndOfBuffer = 'EndOfBuffer',
+    CursorLine = 'CursorLine',
+    VertSplit = 'VertSplit',
+    CursorColumn = 'CursorColumn'
+  }
+end
+
+function M.setup()
+  local higlight_groups = get_hl_groups()
+  for k, d in pairs(higlight_groups) do
     local gui = d.gui or 'NONE'
     api.nvim_command('hi def LuaTree'..k..' gui='..gui..' guifg='..d.fg)
   end
 
-  for k, d in pairs(LINKS) do
+  local links = get_links()
+  for k, d in pairs(links) do
     api.nvim_command('hi def link LuaTree'..k..' '..d)
   end
 end

lua/lib/config.lua

@@ -1,57 +1,50 @@
-local api = vim.api
-
 local M = {}
 
-local function get(var, fallback)
-  if api.nvim_call_function('exists', { var }) == 1 then
-    return api.nvim_get_var(var)
-  else
-    return fallback
-  end
-end
-
-local function get_color_from_hl(hl_name, fallback)
-  local id = api.nvim_get_hl_id_by_name(hl_name)
-  if not id then return fallback end
+function M.get_icon_state()
+  local show_icons = vim.g.lua_tree_show_icons or { git = 1, folders = 1, files = 1 }
+  local icons = {
+    default = nil,
+    git_icons = {
+      unstaged = "✗",
+      staged = "✓",
+      unmerged = "═",
+      renamed = "➜",
+      untracked = "★"
+    }
+  }
 
-  local hl = api.nvim_get_hl_by_id(id, true)
-  if not hl or not hl.foreground then return fallback end
+  local user_icons = vim.g.lua_tree_icons
+  if user_icons then
+    if user_icons.default then
+      icons.default = user_icons.default
+    end
+    for key, val in pairs(user_icons.git) do
+      if icons.git_icons[key] then
+        icons.git_icons[key] = val
+      end
+    end
+  end
 
-  return hl.foreground
+  return {
+    show_file_icon = show_icons.files == 1 and vim.g.nvim_web_devicons == 1,
+    show_folder_icon = show_icons.folders == 1,
+    show_git_icon = show_icons.git == 1,
+    icons = icons
+  }
 end
 
-local HAS_DEV_ICONS = api.nvim_call_function('exists', { "*WebDevIconsGetFileTypeSymbol" }) == 1
-
-local show_icons = get('lua_tree_show_icons', { git = 1, folders = 1, files = 1 })
-
-M.SHOW_FILE_ICON = HAS_DEV_ICONS and show_icons.files == 1
-M.SHOW_FOLDER_ICON = show_icons.folders == 1
-M.SHOW_GIT_ICON = show_icons.git == 1
-
-function M.get_colors()
+function M.get_bindings()
+  local keybindings = vim.g.lua_tree_bindings or {}
   return {
-    red = get('terminal_color_1', get_color_from_hl('Keyword', 'Red')),
-    green = get('terminal_color_2', get_color_from_hl('Character', 'Green')),
-    yellow = get('terminal_color_3', get_color_from_hl('PreProc', 'Yellow')),
-    blue = get('terminal_color_4', get_color_from_hl('Include', 'Blue')),
-    purple = get('terminal_color_5', get_color_from_hl('Define', 'Purple')),
-    cyan = get('terminal_color_6', get_color_from_hl('Conditional', 'Cyan')),
-    orange = get('terminal_color_11', get_color_from_hl('Number', 'Orange')),
-    dark_red = get('terminal_color_9', get_color_from_hl('Keyword', 'DarkRed')),
+    edit        = keybindings.edit or '<CR>',
+    edit_vsplit = keybindings.edit_vsplit or '<C-v>',
+    edit_split  = keybindings.edit_split or '<C-x>',
+    edit_tab    = keybindings.edit_tab or '<C-t>',
+    cd          = keybindings.cd or '<C-]>',
+    create      = keybindings.create or 'a',
+    remove      = keybindings.remove or 'd',
+    rename      = keybindings.rename or 'r',
   }
 end
 
-local keybindings = get('lua_tree_bindings', {});
-
-M.bindings = {
-  edit = keybindings.edit or '<CR>',
-  edit_vsplit = keybindings.edit_vsplit or '<C-v>',
-  edit_split = keybindings.edit_split or '<C-x>',
-  edit_tab = keybindings.edit_tab or '<C-t>',
-  cd = keybindings.cd or '.',
-  create = keybindings.create or 'a',
-  remove = keybindings.remove or 'd',
-  rename = keybindings.rename or 'r',
-}
-
 return M