feat: rewrite git management with sqlite

use `tami5/sqlite.nvim` to store git informations. Run git small
commands in system and run git status management in a libuv job. This
allows to fetch millions of status and add them partially in the
database to avoid destroying the lua memory with huge tables. The paths
can then be retrieved partially to apply updates.

Author: kyazdani42

Diff for: lua/nvim-tree.lua

@@ -379,7 +379,7 @@ local function setup_autocommands(opts)
     """ reset highlights when colorscheme is changed
     au ColorScheme * lua require'nvim-tree'.reset_highlight()
 
-    au BufWritePost * lua require'nvim-tree'.refresh()
+    au BufWritePost * lua require'nvim-tree.lib'.refresh_tree(true)
     au User FugitiveChanged,NeogitStatusRefreshed lua require'nvim-tree'.refresh()
   ]]
 
@@ -436,6 +436,13 @@ local DEFAULT_OPTS = {
       error = "",
     }
   },
+  git = {
+    enable = true,
+    show_highlights = false,
+    show_icons = true,
+    icon_placement = 'left',
+    ignore = true,
+  }
 }
 
 function M.setup(conf)
@@ -464,6 +471,7 @@ function M.setup(conf)
   require'nvim-tree.colors'.setup()
   require'nvim-tree.view'.setup(opts.view or {})
   require'nvim-tree.diagnostics'.setup(opts)
+  require'nvim-tree.git'.setup(opts)
 
   setup_autocommands(opts)
   setup_vim_commands()

Diff for: lua/nvim-tree/git.lua

@@ -0,0 +1,80 @@
+local _, sqlite = pcall(require, 'sqlite')
+
+local uv = vim.loop
+local utils = require'nvim-tree.utils'
+
+local Db = {}
+Db.__index = Db
+
+local function create_uri()
+  local cache = vim.fn.stdpath "cache"
+  local path = utils.path_join({cache, "nvim-tree-sqlite-"..uv.random(2)})
+  while uv.fs_access(path, 'R') do
+    path = utils.path_join({cache, "nvim-tree-sqlite-"..uv.random(2)})
+  end
+  return path
+end
+
+local function init_db()
+  local uri = create_uri()
+  local db = sqlite {
+    uri = uri,
+    statuses = {
+      path = "text",
+      status = "text",
+    },
+  }
+  db:open()
+  vim.cmd [[
+    augroup NvimTreeSqlite
+      au VimLeavePre * lua require'nvim-tree.git'.cleanup()
+    augroup END
+  ]]
+  return db, uri
+end
+
+function Db.new()
+  local db, uri = init_db()
+  return setmetatable({
+    db = db,
+    uri = uri,
+    insertion_cache = {}
+  }, Db)
+end
+
+function Db:cleanup()
+  self.db:close()
+  uv.fs_unlink(self.uri)
+end
+
+function Db:insert_cache()
+  if #self.insertion_cache == 0 then
+    return
+  end
+  self.db:insert("statuses", self.insertion_cache)
+  self.insertion_cache = {}
+end
+
+function Db:insert(path, status)
+  if #self.insertion_cache < 2000 then
+    return table.insert(self.insertion_cache, { path = path, status = status })
+  else
+    self:insert_cache()
+  end
+end
+
+function Db:get_from_path(cwd)
+  local query = "select * from statuses where path LIKE ?"
+  local statuses = self.db:eval(query, cwd..'%')
+  if type(statuses) == "table" then
+    return statuses
+  else
+    return {}
+  end
+end
+
+function Db:clean_paths(cwd)
+  self.db:eval("delete from statuses where path LIKE ?", cwd..'%')
+end
+
+return Db

Diff for: lua/nvim-tree/git/db.lua

@@ -0,0 +1,114 @@
+local utils = require'nvim-tree.git.utils'
+local updater = require'nvim-tree.git.tree-update'
+local Runner = require'nvim-tree.git.runner'
+
+local M = {
+  db = nil,
+  toplevels = {},
+}
+
+function M.handle_update(node)
+  return function()
+    local filter_ignored = M.config.ignore and not require'nvim-tree.populate'.show_ignored
+    updater.update(M.db, node, filter_ignored)
+    require'nvim-tree.lib'.redraw()
+  end
+end
+
+function M.set_toplevel(path, toplevel)
+  if not M.config.enable then
+    return
+  end
+  toplevel = toplevel or utils.get_toplevel(path)
+  if not toplevel or M.toplevels[toplevel] ~= nil then
+    return
+  end
+
+  M.toplevels[toplevel] = utils.show_untracked(toplevel)
+end
+
+function M.run_git_status(toplevel, node)
+  local show_untracked = M.toplevels[toplevel]
+  local runner = Runner.new {
+    db = M.db,
+    toplevel = toplevel,
+    show_untracked = show_untracked,
+    with_ignored = M.config.ignore
+  }
+
+  runner:run(M.handle_update(node))
+end
+
+function M.run(node)
+  if not M.config.enable then
+    return
+  end
+
+  local toplevel = utils.get_toplevel(node.absolute_path)
+  if not toplevel then
+    return
+  end
+
+  if M.toplevels[toplevel] == nil then
+    M.set_toplevel(nil, toplevel)
+    M.run_git_status(toplevel, node)
+  else
+    M.handle_update(node)()
+  end
+end
+
+local function check_sqlite()
+  local has_sqlite = pcall(require, 'sqlite')
+  if M.config.enable and not has_sqlite then
+    local info = "[NvimTree] Git integration requires sqlite.lua to be installed (see :help nvim-tree-git)"
+    require'nvim-tree.utils'.echo_warning(info)
+    M.config.enable = false
+  end
+end
+
+function M.reload()
+  if not M.config.enable then
+    return
+  end
+
+  for toplevel, show_untracked in pairs(M.toplevels) do
+    local runner = Runner.new {
+      db = M.db,
+      toplevel = toplevel,
+      show_untracked = show_untracked,
+      with_ignored = M.config.ignore
+    }
+    local tree = require'nvim-tree.lib'.Tree
+    local node
+    if tree.cwd == toplevel then
+      node = { entries = tree.entries, absolute_path = tree.cwd }
+    else
+      node = require'nvim-tree.utils'.find_node(tree.entries, function(n)
+        return toplevel == n.absolute_path
+      end)
+    end
+    if node then
+      runner:run(M.handle_update(node))
+    end
+  end
+end
+
+function M.cleanup()
+  M.db:cleanup()
+end
+
+function M.setup(opts)
+  M.config = {}
+  M.config.enable = opts.git.enable
+  M.config.show_highlights = opts.git.show_highlights
+  M.config.show_icons = opts.git.show_icons
+  M.config.icon_placement = opts.git.placement
+  M.config.ignore = opts.git.ignore
+  check_sqlite()
+
+  if M.config.enable then
+    M.db = require'nvim-tree.git.db'.new()
+  end
+end
+
+return M