feat(treesitter): track installed tree-sitter parser version

Author: kristijanhusak

.gitignore

@@ -42,3 +42,6 @@ luac.out
 
 # Auto-generated vim helptags
 doc/tags
+
+# Lock file
+.org-ts-lock.json

lua/orgmode/config/init.lua

@@ -30,17 +30,11 @@ function Config:__index(key)
 end
 
 function Config:install_grammar()
-  local ok, result, err = pcall(vim.treesitter.language.add, 'org')
-  if not ok or (not result and err ~= nil) then
-    require('orgmode.utils.treesitter.install').run()
-    return true
-  end
-  return false
+  return require('orgmode.utils.treesitter.install').install()
 end
 
----@param url? string
-function Config:reinstall_grammar(url)
-  return require('orgmode.utils.treesitter.install').run(url)
+function Config:reinstall_grammar()
+  return require('orgmode.utils.treesitter.install').reinstall()
 end
 
 ---@param opts table

lua/orgmode/utils/treesitter/install.lua

@@ -6,6 +6,47 @@ local M = {
   compilers = { vim.fn.getenv('CC'), 'cc', 'gcc', 'clang', 'cl', 'zig' },
 }
 
+local required_version = '1.3.4'
+
+function M.install()
+  if M.not_installed() then
+    M.run('install')
+    return true
+  end
+
+  if M.outdated() then
+    M.run('update')
+    return true
+  end
+
+  return false
+end
+
+function M.reinstall()
+  return M.run('reinstall')
+end
+
+function M.outdated()
+  local installed_version = M.get_installed_version()
+  return vim.version.lt(installed_version, required_version)
+end
+
+function M.not_installed()
+  local ok, result, err = pcall(vim.treesitter.language.add, 'org')
+  return not ok or (not result and err ~= nil)
+end
+
+function M.get_installed_version()
+  local lock_file = M.get_lock_file()
+  -- No lock file, assume that version is 1.3.4 (when lock file was introduced)
+  if not vim.uv.fs_stat(lock_file) then
+    utils.writefile(lock_file, vim.json.encode({ version = '1.3.4' })):wait()
+    return '1.3.4'
+  end
+  local file_content = vim.json.decode(utils.readfile(lock_file, { raw = true }):wait())
+  return file_content.version
+end
+
 function M.get_package_path()
   -- Path to this source file, removing the leading '@'
   local source = string.sub(debug.getinfo(1, 'S').source, 2)
@@ -14,6 +55,10 @@ function M.get_package_path()
   return vim.fn.fnamemodify(source, ':p:h:h:h:h:h')
 end
 
+function M.get_lock_file()
+  return M.get_package_path() .. '/.org-ts-lock.json'
+end
+
 function M.select_compiler_args(compiler)
   if string.match(compiler, 'cl$') or string.match(compiler, 'cl.exe$') then
     return {
@@ -70,20 +115,27 @@ function M.exe(cmd, opts)
   end)
 end
 
-function M.get_path(url)
+function M.get_path(url, type)
   local local_path = vim.fn.expand(url)
   local is_local_path = vim.fn.isdirectory(local_path) == 1
 
   if is_local_path then
+    utils.echo_info('Using local version of tree-sitter grammar...')
     return Promise.resolve(local_path)
   end
 
   local path = ('%s/tree-sitter-org'):format(vim.fn.stdpath('cache'))
   vim.fn.delete(path, 'rf')
 
-  utils.echo_info('Installing tree-sitter grammar...')
+  local msg = {
+    install = 'Installing',
+    update = 'Updating',
+    reinstall = 'Reinstalling',
+  }
+
+  utils.echo_info(('%s tree-sitter grammar...'):format(msg[type]))
   return M.exe('git', {
-    args = { 'clone', '--filter=blob:none', url, path },
+    args = { 'clone', '--filter=blob:none', '--depth=1', '--branch=' .. required_version, url, path },
   })
     :next(function(code)
       if code ~= 0 then
@@ -102,9 +154,9 @@ function M.get_path(url)
     end)
 end
 
----@param url? string
-function M.run(url)
-  url = url or 'https://github.com/nvim-orgmode/tree-sitter-org'
+---@param type? 'install' | 'update' | 'reinstall''
+function M.run(type)
+  local url = 'https://github.com/nvim-orgmode/tree-sitter-org'
   local compiler = vim.tbl_filter(function(exe)
     return exe ~= vim.NIL and vim.fn.executable(exe) == 1
   end, M.compilers)[1]
@@ -117,7 +169,7 @@ function M.run(url)
   local package_path = M.get_package_path()
   local path = nil
 
-  return M.get_path(url)
+  return M.get_path(url, type)
     :next(function(directory)
       path = directory
       return M.exe(compiler, {
@@ -133,6 +185,7 @@ function M.run(url)
       if renamed ~= 0 then
         error('[orgmode] Failed to move generated tree-sitter parser to runtime folder', 0)
       end
+      utils.writefile(M.get_lock_file(), vim.json.encode({ version = required_version })):wait()
       utils.echo_info('Done!')
       return true
     end))