chore: Misc housekeeping.

Author: sindrets

lua/diffview/actions.lua

@@ -1,12 +1,12 @@
 local lazy = require("diffview.lazy")
 
 local DiffView = lazy.access("diffview.scene.views.diff.diff_view", "DiffView") ---@type DiffView|LazyModule
-local HelpPanel = lazy.access("diffview.ui.panels.help_panel", "HelpPanel") ---@type HelpPanel|LazyModule
 local FileHistoryView = lazy.access("diffview.scene.views.file_history.file_history_view", "FileHistoryView") ---@type FileHistoryView|LazyModule
+local HelpPanel = lazy.access("diffview.ui.panels.help_panel", "HelpPanel") ---@type HelpPanel|LazyModule
 local StandardView = lazy.access("diffview.scene.views.standard.standard_view", "StandardView") ---@type StandardView|LazyModule
-local vcs = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
 local lib = lazy.require("diffview.lib") ---@module "diffview.lib"
 local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
+local vcs_utils = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
 
 local Diff1 = lazy.access("diffview.scene.layouts.diff_1", "Diff1") ---@type Diff1|LazyModule
 local Diff2Hor = lazy.access("diffview.scene.layouts.diff_2_hor", "Diff2Hor") ---@type Diff2Hor|LazyModule
@@ -167,7 +167,7 @@ function M.next_conflict()
     local curfile = main.file
 
     if main:is_valid() and curfile:is_valid() then
-      local conflicts, _, cur_idx = vcs.parse_conflicts(
+      local conflicts, _, cur_idx = vcs_utils.parse_conflicts(
         api.nvim_buf_get_lines(curfile.bufnr, 0, -1, false),
         main.id
       )
@@ -198,7 +198,7 @@ function M.prev_conflict()
     local curfile = main.file
 
     if main:is_valid() and curfile:is_valid() then
-      local conflicts, _, cur_idx = vcs.parse_conflicts(
+      local conflicts, _, cur_idx = vcs_utils.parse_conflicts(
         api.nvim_buf_get_lines(curfile.bufnr, 0, -1, false),
         main.id
       )
@@ -335,7 +335,7 @@ function M.conflict_choose(target)
       local curfile = main.file
 
       if main:is_valid() and curfile:is_valid() then
-        local _, cur = vcs.parse_conflicts(
+        local _, cur = vcs_utils.parse_conflicts(
           api.nvim_buf_get_lines(curfile.bufnr, 0, -1, false),
           main.id
         )

lua/diffview/api/views/diff/diff_view.lua

@@ -6,7 +6,7 @@ local FilePanel = lazy.access("diffview.scene.views.diff.file_panel", "FilePanel
 local Rev = lazy.access("diffview.vcs.adapters.git.rev", "GitRev") ---@type GitRev|LazyModule
 local RevType = lazy.access("diffview.vcs.rev", "RevType") ---@type RevType|LazyModule
 local async = lazy.require("plenary.async") ---@module "plenary.async"
-local vcs = lazy.require("diffview.vcs") ---@module "diffview.vcs"
+local vcs_utils = lazy.require("diffview.vcs") ---@module "diffview.vcs"
 local logger = lazy.require("diffview.logger") ---@module "diffview.logger"
 local oop = lazy.require("diffview.oop") ---@module "diffview.oop"
 local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
@@ -34,7 +34,7 @@ function CDiffView:init(opt)
   logger.info("[api] Creating a new Custom DiffView.")
   self.valid = false
 
-  local err, adapter = vcs.get_adapter({ top_indicators = { opt.git_root } })
+  local err, adapter = vcs_utils.get_adapter({ top_indicators = { opt.git_root } })
 
   if err then
     utils.err(

lua/diffview/init.lua

@@ -5,18 +5,12 @@ end
 local hl = require("diffview.hl")
 local lazy = require("diffview.lazy")
 
----@module "diffview.arg_parser"
-local arg_parser = lazy.require("diffview.arg_parser")
----@module "diffview.config"
-local config = lazy.require("diffview.config")
----@module "diffview.vcs"
-local vcs = lazy.require("diffview.vcs")
----@module "diffview.lib"
-local lib = lazy.require("diffview.lib")
----@module "diffview.logger"
-local logger = lazy.require("diffview.logger")
----@module "diffview.utils"
-local utils = lazy.require("diffview.utils")
+local arg_parser = lazy.require("diffview.arg_parser") ---@module "diffview.arg_parser"
+local config = lazy.require("diffview.config") ---@module "diffview.config"
+local lib = lazy.require("diffview.lib") ---@module "diffview.lib"
+local logger = lazy.require("diffview.logger") ---@module "diffview.logger"
+local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
+local vcs = lazy.require("diffview.vcs") ---@module "diffview.vcs"
 
 local api = vim.api
 

lua/diffview/scene/file_entry.lua

@@ -1,20 +1,13 @@
 local lazy = require("diffview.lazy")
 local oop = require("diffview.oop")
 
----@type vcs.File|LazyModule
-local File = lazy.access("diffview.vcs.file", "File")
----@type RevType|LazyModule
-local RevType = lazy.access("diffview.vcs.rev", "RevType")
----@type Diff1|LazyModule
-local Diff1 = lazy.access("diffview.scene.layouts.diff_1", "Diff1")
----@type Diff2|LazyModule
-local Diff2 = lazy.access("diffview.scene.layouts.diff_2", "Diff2")
----@type Diff3|LazyModule
-local Diff3 = lazy.access("diffview.scene.layouts.diff_3", "Diff3")
----@type Diff4|LazyModule
-local Diff4 = lazy.access("diffview.scene.layouts.diff_4", "Diff4")
----@module "diffview.utils"
-local utils = lazy.require("diffview.utils")
+local Diff1 = lazy.access("diffview.scene.layouts.diff_1", "Diff1") ---@type Diff1|LazyModule
+local Diff2 = lazy.access("diffview.scene.layouts.diff_2", "Diff2") ---@type Diff2|LazyModule
+local Diff3 = lazy.access("diffview.scene.layouts.diff_3", "Diff3") ---@type Diff3|LazyModule
+local Diff4 = lazy.access("diffview.scene.layouts.diff_4", "Diff4") ---@type Diff4|LazyModule
+local File = lazy.access("diffview.vcs.file", "File") ---@type vcs.File|LazyModule
+local RevType = lazy.access("diffview.vcs.rev", "RevType") ---@type RevType|LazyModule
+local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
 
 local M = {}
 
@@ -36,7 +29,7 @@ local fstat_cache = {}
 ---@field layout Layout
 ---@field status string
 ---@field stats GitStats
----@field kind git.FileKind
+---@field kind vcs.FileKind
 ---@field commit Commit|nil
 ---@field active boolean
 local FileEntry = oop.create_class("FileEntry")
@@ -48,7 +41,7 @@ local FileEntry = oop.create_class("FileEntry")
 ---@field layout Layout
 ---@field status string
 ---@field stats GitStats
----@field kind git.FileKind
+---@field kind vcs.FileKind
 ---@field commit? Commit
 
 ---FileEntry constructor

lua/diffview/scene/views/diff/diff_view.lua

@@ -16,7 +16,7 @@ local config = lazy.require("diffview.config") ---@module "diffview.config"
 local debounce = lazy.require("diffview.debounce") ---@module "diffview.debounce"
 local logger = lazy.require("diffview.logger") ---@module "diffview.logger"
 local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
-local vcs = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
+local vcs_utils = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
 
 local api = vim.api
 local M = {}
@@ -76,7 +76,7 @@ function DiffView:init(opt)
       local file = entry.layout:get_main_win().file
 
       local count_conflicts = vim.schedule_wrap(function()
-        local conflicts = vcs.parse_conflicts(api.nvim_buf_get_lines(file.bufnr, 0, -1, false))
+        local conflicts = vcs_utils.parse_conflicts(api.nvim_buf_get_lines(file.bufnr, 0, -1, false))
 
         entry.stats = entry.stats or {}
         entry.stats.conflicts = #conflicts
@@ -277,7 +277,7 @@ end
 ---@return string[] err
 ---@return FileDict
 DiffView.get_updated_files = async.wrap(function(self, callback)
-  vcs.diff_file_list(
+  vcs_utils.diff_file_list(
       self.adapter,
       self.left,
       self.right,
@@ -304,7 +304,7 @@ DiffView.update_files = debounce.debounce_trailing(100, true, vim.schedule_wrap(
     -- If left is tracking HEAD and right is LOCAL: Update HEAD rev.
     local new_head
     if self.left.track_head and self.right.type == RevType.LOCAL then
-      new_head = vcs.head_rev(self.adapter.ctx.toplevel)
+      new_head = self.adapter:head_rev()
       if new_head and self.left.commit ~= new_head.commit then
         self.left = new_head
       else

lua/diffview/scene/views/diff/listeners.lua

@@ -5,7 +5,7 @@ local RevType = lazy.access("diffview.vcs.rev", "RevType") ---@type RevType|Lazy
 local actions = lazy.require("diffview.actions") ---@module "diffview.actions"
 local async = lazy.require("plenary.async") ---@module "plenary.async"
 local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
-local vcs = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
+local vcs_utils = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
 
 local api = vim.api
 
@@ -220,7 +220,7 @@ return function(view)
           utils.err("The file is open with unsaved changes! Aborting file restoration.")
           return
         end
-        vcs.restore_file(view.adapter, file.path, file.kind, commit, function()
+        vcs_utils.restore_file(view.adapter, file.path, file.kind, commit, function()
           async.util.scheduler()
           view:update_files()
         end)

lua/diffview/ui/models/file_tree/file_tree.lua

@@ -8,7 +8,7 @@ local M = {}
 ---@class DirData
 ---@field name string
 ---@field path string
----@field kind git.FileKind
+---@field kind vcs.FileKind
 ---@field collapsed boolean
 ---@field status string
 ---@field _node Node

lua/diffview/vcs/adapter.lua

@@ -1,17 +1,22 @@
-local oop = require('diffview.oop')
-local utils = require('diffview.utils')
-local logger = require('diffview.logger')
-local arg_parser = require('diffview.arg_parser')
-local RevType = require("diffview.vcs.rev").RevType
-local Rev = require("diffview.vcs.rev").Rev
+local Job = require("plenary.job")
+local async = require("plenary.async")
+local lazy = require("diffview.lazy")
+local oop = require("diffview.oop")
+
+local JobStatus = lazy.access("diffview.vcs.utils", "JobStatus") ---@type JobStatus|LazyModule
+local Rev = lazy.access("diffview.vcs.rev", "Rev") ---@type Rev|LazyModule
+local RevType = lazy.access("diffview.vcs.rev", "RevType") ---@type RevType|LazyModule
+local arg_parser = lazy.require("diffview.arg_parser") ---@module "diffview.arg_parser"
+local logger = lazy.require("diffview.logger") ---@module "diffview.logger"
+local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
+local vcs_utils = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
 
 local M = {}
 
 ---@class vcs.adapter.LayoutOpt
 ---@field default_layout Diff2
 ---@field merge_layout Layout
 
-
 ---@class vcs.adapter.VCSAdapter.Bootstrap
 ---@field done boolean # Did the bootstrapping
 ---@field ok boolean # Bootstrapping was successful
@@ -33,7 +38,7 @@ local M = {}
 ---@field bootstrap vcs.adapter.VCSAdapter.Bootstrap
 ---@field ctx vcs.adapter.VCSAdapter.Ctx
 ---@field flags vcs.adapter.VCSAdapter.Flags
-local VCSAdapter = oop.create_class('VCSAdapter')
+local VCSAdapter = oop.create_class("VCSAdapter")
 
 VCSAdapter.Rev = Rev
 
@@ -271,15 +276,59 @@ end
 
 ---Restore file
 ---@param path string
----@param kind '"staged"' | '"working"'
+---@param kind vcs.FileKind
 ---@param commit string?
----@return boolean # Restore was successful
+---@return boolean success
+---@return string? undo # If the adapter supports it: a command that will undo the restoration.
 function VCSAdapter:file_restore(path, kind, commit)
   oop.abstract_stub()
 end
 
 ---@diagnostic enable: unused-local, missing-return
 
+---@param self VCSAdapter
+---@param args string[]
+---@param callback fun(stderr: string[]?, stdout: string[]?)
+VCSAdapter.show = async.wrap(function(self, args, callback)
+  local job = Job:new({
+    command = self:bin(),
+    args = self:get_show_args(args),
+    cwd = self.ctx.toplevel,
+    ---@type Job
+    on_exit = async.void(function(j)
+      local context = "vcs.utils.show()"
+      utils.handle_job(j, {
+        fail_on_empty = true,
+        context = context,
+        debug_opt = { no_stdout = true, context = context },
+      })
+
+      if j.code ~= 0 then
+        callback(j:stderr_result() or {}, nil)
+        return
+      end
+
+      local out_status
+
+      if #j:result() == 0 then
+        async.util.scheduler()
+        out_status = vcs_utils.ensure_output(2, { j }, context)
+      end
+
+      if out_status == JobStatus.ERROR then
+        callback(j:stderr_result() or {}, nil)
+        return
+      end
+
+      callback(nil, j:result())
+    end),
+  })
+  -- Problem: Running multiple 'show' jobs simultaneously may cause them to fail
+  -- silently.
+  -- Solution: queue them and run them one after another.
+  vcs_utils.queue_sync_job(job)
+end, 3)
+
 ---Convert revs to string representation.
 ---@param left Rev
 ---@param right Rev

lua/diffview/vcs/adapters/git/init.lua

@@ -1227,6 +1227,9 @@ function GitAdapter:get_files_args(args)
   return utils.vec_join(self:args(), "ls-files", "--others", "--exclude-standard", args)
 end
 
+---@param path string
+---@param kind vcs.FileKind
+---@param commit string?
 function GitAdapter:file_restore(path, kind, commit)
   local out, code
   local abs_path = utils.path:join(self.ctx.toplevel, path)
@@ -1245,7 +1248,7 @@ function GitAdapter:file_restore(path, kind, commit)
     out, code = self:exec_sync({ "hash-object", "-w", "--", path }, self.ctx.toplevel)
     if code ~= 0 then
       utils.err("Failed to write file blob into the object database. Aborting file restoration.", true)
-      return nil
+      return false
     end
   end
 
@@ -1272,7 +1275,7 @@ function GitAdapter:file_restore(path, kind, commit)
       end
     end
 
-    if kind == "working" then
+    if kind == "working" or kind == "conflicting" then
       -- File is untracked and has no history: delete it from fs.
       local ok, err = utils.path:unlink(abs_path)
       if not ok then
@@ -1281,7 +1284,7 @@ function GitAdapter:file_restore(path, kind, commit)
             :format(abs_path),
           err
         }, true)
-        return nil
+        return false
       end
     else
       -- File only exists in index
@@ -1298,7 +1301,7 @@ function GitAdapter:file_restore(path, kind, commit)
     )
   end
 
-  return undo
+  return true, undo
 end
 
 function GitAdapter:reset_files(paths)

lua/diffview/vcs/file.lua

@@ -6,14 +6,13 @@ local RevType = lazy.access("diffview.vcs.rev", "RevType") ---@type RevType|Lazy
 local async = lazy.require("plenary.async") ---@module "plenary.async"
 local config = lazy.require("diffview.config") ---@module "diffview.config"
 local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
-local vcs = lazy.require("diffview.vcs.utils") ---@module "diffview.vcs.utils"
 
 local pl = lazy.access(utils, "path") ---@type PathLib|LazyModule
 
 local api = vim.api
 local M = {}
 
----@alias git.FileDataProducer fun(kind: git.FileKind, path: string, pos: "left"|"right"): string[]
+---@alias git.FileDataProducer fun(kind: vcs.FileKind, path: string, pos: "left"|"right"): string[]
 
 ---@class vcs.File : diffview.Object
 ---@field adapter GitAdapter
@@ -22,7 +21,7 @@ local M = {}
 ---@field parent_path string
 ---@field basename string
 ---@field extension string
----@field kind git.FileKind
+---@field kind vcs.FileKind
 ---@field nulled boolean
 ---@field rev Rev
 ---@field commit Commit?
@@ -201,8 +200,7 @@ function File:create_buffer(callback)
     end, nil)
 
   else
-    vcs.show(
-      self.adapter,
+    self.adapter:show(
       { ("%s:%s"):format(self.rev:object_name() or "", self.path) },
       function(err, result)
         if err then