feat(config): add hide_merge_artifacts option

Filter out common merge artifact files (*.orig, *.BACKUP.*, *.BASE.*,
*.LOCAL.*, *.REMOTE.*) from file listings when the option is enabled.

Author: dlyongemallo

doc/diffview_defaults.txt

@@ -10,6 +10,7 @@ DEFAULT CONFIG                                  *diffview.defaults*
     use_icons = true,         -- Requires nvim-web-devicons or mini.icons
     show_help_hints = true,   -- Show hints for how to open the help panel
     watch_index = true,       -- Update views and index buffers when the git index changes.
+    hide_merge_artifacts = false, -- Hide merge artifact files (*.orig, *.BACKUP.*, *.BASE.*, *.LOCAL.*, *.REMOTE.*)
     icons = {                 -- Only applies when use_icons is true.
       folder_closed = "",
       folder_open = "",

lua/diffview/config.lua

@@ -44,6 +44,7 @@ M.defaults = {
   use_icons = true,
   show_help_hints = true,
   watch_index = true,
+  hide_merge_artifacts = false, -- Hide merge artifact files (*.orig, *.BACKUP.*, etc.)
   icons = {
     folder_closed = "",
     folder_open = "",

lua/diffview/vcs/utils.lua

@@ -11,8 +11,47 @@ local await = async.await
 local fmt = string.format
 local logger = DiffviewGlobal.logger
 
+local config = require("diffview.config")
+
 local M = {}
 
+-- Patterns for merge artifact files.
+local merge_artifact_patterns = {
+  "%.orig$",
+  "%.BACKUP%.",
+  "%.BASE%.",
+  "%.LOCAL%.",
+  "%.REMOTE%.",
+}
+
+---Check if a file path matches a merge artifact pattern.
+---@param path string
+---@return boolean
+function M.is_merge_artifact(path)
+  for _, pattern in ipairs(merge_artifact_patterns) do
+    if path:match(pattern) then
+      return true
+    end
+  end
+  return false
+end
+
+---Filter out merge artifacts from a file list if configured.
+---@param files FileEntry[]
+---@return FileEntry[]
+function M.filter_merge_artifacts(files)
+  if not config.get_config().hide_merge_artifacts then
+    return files
+  end
+  local result = {}
+  for _, file in ipairs(files) do
+    if not M.is_merge_artifact(file.path) then
+      result[#result + 1] = file
+    end
+  end
+  return result
+end
+
 ---@enum JobStatus
 local JobStatus = oop.enum({
   SUCCESS  = 1,
@@ -140,6 +179,11 @@ M.diff_file_list = async.wrap(function(adapter, left, right, path_args, dv_opt,
     return
   end
 
+  -- Filter out merge artifacts if configured.
+  files:set_working(M.filter_merge_artifacts(files.working))
+  files:set_conflicting(M.filter_merge_artifacts(files.conflicting))
+  files:set_staged(M.filter_merge_artifacts(files.staged))
+
   files:update_file_trees()
   callback(nil, files)
 end, 7)