feat: add heat map

Author: lewis6991

doc/gitsigns.txt

@@ -488,6 +488,16 @@ stage_hunk({range}, {opts}, {callback?})               *gitsigns.stage_hunk()*
                               Stage all contiguous hunks. Only useful if 'diff_opts'
                               contains `linematch`. Defaults to `true`.
 
+toggle_heatmap({value})                            *gitsigns.toggle_heatmap()*
+                Toggle |gitsigns-config-heat_map|
+
+                Parameters: ~
+                    {value} (boolean|nil): Value to set toggle. If `nil`
+                            the toggle value is inverted.
+
+                Returns: ~
+                    (boolean): Current value of |gitsigns-config-heat_map|
+
 toggle_deleted({value})                            *gitsigns.toggle_deleted()*
                 DEPRECATED: Use |gitsigns.preview_hunk_inline()|
 
@@ -717,6 +727,11 @@ show_deleted                                    *gitsigns-config-show_deleted*
 
       Note: Virtual lines currently use the highlight `GitSignsDeleteVirtLn`.
 
+heat_map                                            *gitsigns-config-heat_map*
+      Type: `boolean`, Default: `false`
+
+      Show a blame heatmap for the current buffer.
+
 diff_opts                                          *gitsigns-config-diff_opts*
       Type: `table[extended]`, Default: derived from 'diffopt'
 

lua/gitsigns/actions.lua

@@ -115,7 +115,7 @@ M.toggle_word_diff = function(value)
     config.word_diff = not config.word_diff
   end
   -- Don't use refresh() to avoid flicker
-  util.redraw({ buf = 0, range = { vim.fn.line('w0') - 1, vim.fn.line('w$') } })
+  util.redraw({ range = { 0, -1 } })
   return config.word_diff
 end
 
@@ -150,6 +150,23 @@ M.toggle_deleted = function(value)
   return config.show_deleted
 end
 
+--- Toggle |gitsigns-config-heat_map|
+---
+--- @param value boolean|nil Value to set toggle. If `nil`
+---     the toggle value is inverted.
+--- @return boolean : Current value of |gitsigns-config-heat_map|
+M.toggle_heatmap = function(value)
+  if value ~= nil then
+    config.heat_map = value
+  else
+    config.heat_map = not config.heat_map
+  end
+
+  M.refresh()
+
+  return config.heat_map
+end
+
 --- @param bufnr? integer
 --- @param hunks? Gitsigns.Hunk.Hunk[]?
 --- @return Gitsigns.Hunk.Hunk? hunk
@@ -1546,6 +1563,9 @@ M.refresh = async.create(0, function()
     v:invalidate(true)
     manager.update(k)
   end
+  for k in pairs(cache) do
+    util.redraw({ buf = k, range = { 0, -1 } })
+  end
 end)
 
 --- @param name string

lua/gitsigns/blame.lua

@@ -46,7 +46,7 @@ end
 ---@param text string
 ---@return string
 local function lalign(amount, text)
-  local len = vim.str_utfindex(text)
+  local len = vim.str_utfindex(text, 'utf-8')
   return text .. string.rep(' ', math.max(0, amount - len))
 end
 
@@ -66,30 +66,32 @@ local M = {}
 local function render(blame, win, main_win, buf_sha)
   local max_author_len = 0
 
-  for _, blame_info in pairs(blame) do
-    max_author_len = math.max(max_author_len, (vim.str_utfindex(blame_info.commit.author)))
+  for _, b in pairs(blame) do
+    max_author_len = math.max(max_author_len, (vim.str_utfindex(b.commit.author, 'utf-8')))
   end
 
   local lines = {} --- @type string[]
   local last_sha --- @type string?
   local cnt = 0
   local commit_lines = {} --- @type table<integer,true>
-  for i, hl in pairs(blame) do
-    local sha = hl.commit.abbrev_sha
+
+  for i, b in pairs(blame) do
+    local commit = b.commit
+    local sha = commit.abbrev_sha
     local next_sha = blame[i + 1] and blame[i + 1].commit.abbrev_sha or nil
     if sha == last_sha then
       cnt = cnt + 1
       local c = sha == next_sha and chars.mid or chars.last
-      lines[i] = cnt == 1 and string.format('%s %s', c, hl.commit.summary) or c
+      lines[i] = cnt == 1 and string.format('%s %s', c, commit.summary) or c
     else
       cnt = 0
       commit_lines[i] = true
       lines[i] = string.format(
         '%s %s %s %s',
         chars.first,
         sha,
-        lalign(max_author_len, hl.commit.author),
-        util.expand_format('<author_time>', hl.commit)
+        lalign(max_author_len, commit.author),
+        util.expand_format('<author_time>', commit)
       )
     end
     last_sha = sha

lua/gitsigns/cache.lua

@@ -5,12 +5,18 @@ local M = {
   CacheEntry = {},
 }
 
+--- @class (exact) Gitsigns.CacheEntry.Blame
+--- @field [integer] Gitsigns.BlameInfo?
+--- @field max_time? integer
+--- @field min_time? integer
+
 --- @class (exact) Gitsigns.CacheEntry
 --- @field bufnr              integer
 --- @field file               string
 --- @field compare_text?      string[]
 --- @field hunks?             Gitsigns.Hunk.Hunk[]
 --- @field force_next_update? boolean
+--- @field has_heat_map_marks? boolean
 --- @field file_mode?         boolean
 ---
 --- @field compare_text_head? string[]
@@ -19,7 +25,8 @@ local M = {
 --- @field staged_diffs?      Gitsigns.Hunk.Hunk[]
 --- @field gitdir_watcher?    uv.uv_fs_event_t
 --- @field git_obj            Gitsigns.GitObj
---- @field blame?             table<integer,Gitsigns.BlameInfo?>
+--- @field blame?             Gitsigns.CacheEntry.Blame
+--- @field commits?           table<string,Gitsigns.CommitInfo?>
 ---
 --- @field update_lock?       true Update in progress
 local CacheEntry = M.CacheEntry
@@ -43,6 +50,7 @@ function CacheEntry:invalidate(all)
   self.hunks = nil
   self.hunks_staged = nil
   self.blame = nil
+  self.commits = nil
   if all then
     -- The below doesn't need to be invalidated
     -- if the buffer changes
@@ -82,6 +90,7 @@ local BLAME_THRESHOLD_LEN = 10000
 --- @param lnum? integer
 --- @param opts? Gitsigns.BlameOpts
 --- @return table<integer,Gitsigns.BlameInfo?>
+--- @return table<string,Gitsigns.CommitInfo?>
 --- @return boolean? full
 function CacheEntry:run_blame(lnum, opts)
   local bufnr = self.bufnr
@@ -100,13 +109,13 @@ function CacheEntry:run_blame(lnum, opts)
     local tick = vim.b[bufnr].changedtick
     local lnum0 = vim.api.nvim_buf_line_count(bufnr) > BLAME_THRESHOLD_LEN and lnum or nil
     -- TODO(lewis6991): Cancel blame on changedtick
-    local blame = self.git_obj:run_blame(contents, lnum0, self.git_obj.revision, opts)
+    local blame, commits = self.git_obj:run_blame(contents, lnum0, self.git_obj.revision, opts)
     async.schedule()
     if not vim.api.nvim_buf_is_valid(bufnr) then
-      return {}
+      return {}, {}
     end
     if vim.b[bufnr].changedtick == tick then
-      return blame, lnum0 == nil
+      return blame, commits, lnum0 == nil
     end
   end
 end
@@ -153,7 +162,8 @@ function CacheEntry:get_blame(lnum, opts)
       blame[lnum] = Blame.get_blame_nc(relpath, lnum)
     else
       -- Refresh/update cache
-      local b, full = self:run_blame(lnum, opts)
+      local b, commits, full = self:run_blame(lnum, opts)
+      self.commits = vim.tbl_extend('force', self.commits or {}, commits)
       if lnum and not full then
         blame[lnum] = b[lnum]
       else
@@ -166,6 +176,25 @@ function CacheEntry:get_blame(lnum, opts)
   return blame[lnum]
 end
 
+--- @async
+function CacheEntry:update_blame_times()
+  self:get_blame()
+  local blame = assert(self.blame)
+
+  if blame.max_time and blame.min_time then
+    return
+  end
+
+  local min_time = math.huge
+  for _, c in pairs(assert(self.commits)) do
+    min_time = math.min(min_time, c.author_time)
+  end
+
+  blame.min_time = min_time
+  --- @diagnostic disable-next-line: undefined-field
+  blame.max_time = vim.uv.clock_gettime('realtime').sec
+end
+
 function CacheEntry:destroy()
   local w = self.gitdir_watcher
   if w and not w:is_closing() then

lua/gitsigns/color.lua

@@ -0,0 +1,74 @@
+local M = {}
+
+--- @param value integer
+--- @return [integer, integer, integer]
+function M.int_to_rgb(value)
+  local r = bit.band(bit.rshift(value, 16), 0xFF)
+  local g = bit.band(bit.rshift(value, 8), 0xFF)
+  local b = bit.band(value, 0xFF)
+  return { r, g, b }
+end
+
+--- @param rgb [integer, integer, integer]
+--- @return integer
+function M.rgb_to_int(rgb)
+  return rgb[1] * 0x10000 + rgb[2] * 0x100 + rgb[3]
+end
+
+--- @param stops [integer,integer,integer][]
+--- @param t number 0-1
+--- @return [integer, integer, integer]
+function M.gradient(stops, t)
+  local num_stops = #stops
+  if num_stops < 2 then
+    error('At least two color stops are required')
+  end
+
+  local segment_length = 1 / (num_stops - 1)
+  local segment_index = math.floor(t / segment_length)
+
+  if segment_index >= num_stops - 1 then
+    return { stops[num_stops][1], stops[num_stops][2], stops[num_stops][3] }
+  end
+
+  local local_t = (t - segment_index * segment_length) / segment_length
+
+  local color1 = stops[segment_index + 1]
+  local color2 = stops[segment_index + 2]
+
+  return M.blend(color1, color2, local_t)
+end
+
+--- @param a integer
+--- @param b integer
+--- @param alpha number
+--- @return integer
+local function lerp(a, b, alpha)
+  return math.floor(a + (b - a) * alpha)
+end
+
+--- @param color1 [integer, integer, integer]
+--- @param color2 [integer, integer, integer]
+--- @param alpha number 0-1
+--- @return [integer, integer, integer]
+function M.blend(color1, color2, alpha)
+  return {
+    lerp(color1[1], color2[1], alpha),
+    lerp(color1[2], color2[2], alpha),
+    lerp(color1[3], color2[3], alpha),
+  }
+end
+
+local temp_color_stops = {
+  { 0, 0, 255 }, -- Blue
+  { 255, 0, 0 }, -- Red
+  { 255, 255, 0 }, -- Yellow
+}
+
+--- @param value number 0-1
+--- @return [integer, integer, integer]
+function M.temp(value)
+  return M.gradient(temp_color_stops, value)
+end
+
+return M

lua/gitsigns/config.lua

@@ -64,6 +64,7 @@
 --- @field linehl boolean
 --- @field culhl boolean
 --- @field show_deleted boolean
+--- @field heat_map boolean
 --- @field sign_priority integer
 --- @field _on_attach_pre fun(bufnr: integer, callback: fun(_: table))
 --- @field on_attach fun(bufnr: integer)
@@ -502,6 +503,14 @@ M.schema = {
     ]],
   },
 
+  heat_map = {
+    type = 'boolean',
+    default = false,
+    description = [[
+      Show a blame heatmap for the current buffer.
+    ]],
+  },
+
   diff_opts = {
     type = 'table',
     deep_extend = true,

lua/gitsigns/git.lua

@@ -129,6 +129,7 @@ end
 --- @param revision? string
 --- @param opts? Gitsigns.BlameOpts
 --- @return table<integer,Gitsigns.BlameInfo?>
+--- @return table<string,Gitsigns.CommitInfo?>
 function Obj:run_blame(contents, lnum, revision, opts)
   return require('gitsigns.git.blame').run_blame(self, contents, lnum, revision, opts)
 end

lua/gitsigns/git/blame.lua

@@ -200,6 +200,7 @@ end
 --- @param revision? string
 --- @param opts? Gitsigns.BlameOpts
 --- @return table<integer, Gitsigns.BlameInfo>
+--- @return table<string, Gitsigns.CommitInfo>
 function M.run_blame(obj, contents, lnum, revision, opts)
   local ret = {} --- @type table<integer,Gitsigns.BlameInfo>
 
@@ -217,7 +218,7 @@ function M.run_blame(obj, contents, lnum, revision, opts)
         filename = obj.file,
       }
     end
-    return ret
+    return ret, {}
   end
 
   opts = opts or {}
@@ -256,10 +257,9 @@ function M.run_blame(obj, contents, lnum, revision, opts)
 
   if stderr then
     error_once('Error running git-blame: ' .. stderr)
-    return {}
   end
 
-  return ret
+  return ret, commits
 end
 
 return M