feat: add focus_blame config (#39)

Introduce a new config "focus_blame" to automatically focus on the blame
window when it's opened as well as blame stack push/pop.

Author: fei6409

README.md

@@ -50,6 +50,7 @@ Default config:
         virtual = virtual_view,
         default = window_view,
     },
+    focus_blame = true,
     merge_consecutive = false,
     max_summary_width = 30,
     colors = nil,
@@ -70,6 +71,7 @@ These are the fields you can configure by passing them to the `require('blame').
 - `date_format` - string - Pattern for the date
 - `virtual_style` - "right_align" or "float" - Float moves the virtual text close to the content of the file.
 - `views` - views that can be used when toggling blame
+- `focus_blame` - boolean - Focus on the blame window when it's opened as well as blame stack push/pop
 - `merge_consecutive` - boolean - Merge consecutive blames that are from the same commit
 - `max_summary_width` - If date_message is used, cut the summary if it excedes this number of characters
 - `colors` - list of RGB strings to use instead of randomly generated RGBs for highlights

lua/blame.lua

@@ -22,6 +22,7 @@ local formats = require("blame.formats.default_formats")
 ---@class Config
 ---@field date_format? string Format of the output date
 ---@field views table<string, BlameView>
+---@field focus_blame boolean Focus on the blame window when it's opened as well as blame stack push/pop
 ---@field merge_consecutive boolean Merge consecutive commits and don't repeat
 ---@field virtual_style 'float' | 'right_align' Style of the virtual view
 ---@field colors string[] | nil List of colors to use for highlights. If nill will use random RGB
@@ -38,6 +39,7 @@ local config = {
         virtual = virtual_view,
         default = window_view,
     },
+    focus_blame = true,
     merge_consecutive = false,
     max_summary_width = 30,
     colors = nil,

lua/blame/blame_stack.lua

@@ -9,6 +9,7 @@ local mappings = require("blame.mappings")
 ---@field git_client Git
 ---@field stack_buffer integer
 ---@field stack_info_float_win integer
+---@field blame_window integer
 ---@field original_window integer
 ---@field original_buffer integer
 ---@field git_root string
@@ -18,13 +19,14 @@ local mappings = require("blame.mappings")
 local BlameStack = {}
 
 ---@return BlameStack
-function BlameStack:new(config, blame_view, original_window, file_path, cwd)
+function BlameStack:new(config, blame_view, file_path, cwd)
     local o = {}
     setmetatable(o, { __index = self })
 
     o.config = config
     o.blame_view = blame_view
-    o.original_window = original_window
+    o.blame_window = blame_view.blame_window
+    o.original_window = blame_view.original_window
     o.original_buffer = vim.api.nvim_win_get_buf(o.original_window)
     o.file_path = file_path
     o.cwd = cwd
@@ -147,6 +149,9 @@ function BlameStack:create_blame_buf()
             vim.schedule(function()
                 self:reset_to_original_buf()
                 self:close()
+                if self.config.focus_blame then
+                    vim.api.nvim_set_current_win(self.blame_window)
+                end
             end)
         end,
         buffer = self.stack_buffer,

lua/blame/views/window_view.lua

@@ -106,6 +106,11 @@ function WindowView:open(lines)
 
     -- blame window already opened, updating the content
     if self.blame_window ~= nil then
+        if self.config.focus_blame then
+            vim.api.nvim_set_current_win(self.blame_window)
+        else
+            vim.api.nvim_set_current_win(self.original_window)
+        end
         return self:update_opened_blame_view(blame_lines, lines_with_hl)
     end
 
@@ -162,15 +167,20 @@ function WindowView:open(lines)
             { win = self.blame_window }
         )
     end
-    vim.api.nvim_set_current_win(self.original_window)
+
+    if self.config.focus_blame then
+        vim.api.nvim_set_current_win(self.blame_window)
+    else
+        vim.api.nvim_set_current_win(self.original_window)
+    end
 
     local file_path = vim.api.nvim_buf_get_name(
         vim.api.nvim_win_get_buf(self.original_window)
     )
     local cwd = vim.fn.expand("%:p:h")
     self.cwd = cwd
     self.blame_stack_client =
-        BlameStack:new(self.config, self, self.original_window, file_path, cwd)
+        BlameStack:new(self.config, self, file_path, cwd)
 end
 
 function WindowView:update_opened_blame_view(blame_lines, lines_with_hl)