feat(margin): add margin popup

Author: lucasadelino

lua/neogit/buffers/status/actions.lua

@@ -445,6 +445,11 @@ M.v_log_popup = function(_self)
   return popups.open("log")
 end
 
+---@param _self StatusBuffer
+M.v_margin_popup = function(_self)
+  return popups.open("margin")
+end
+
 ---@param _self StatusBuffer
 M.v_worktree_popup = function(_self)
   return popups.open("worktree")
@@ -1408,6 +1413,11 @@ M.n_log_popup = function(_self)
   return popups.open("log")
 end
 
+---@param _self StatusBuffer
+M.n_margin_popup = function(_self)
+  return popups.open("margin")
+end
+
 ---@param _self StatusBuffer
 M.n_worktree_popup = function(_self)
   return popups.open("worktree")

lua/neogit/buffers/status/init.lua

@@ -128,6 +128,7 @@ function M:open(kind)
         [popups.mapping_for("HelpPopup")]       = self:_action("v_help_popup"),
         [popups.mapping_for("IgnorePopup")]     = self:_action("v_ignore_popup"),
         [popups.mapping_for("LogPopup")]        = self:_action("v_log_popup"),
+        [popups.mapping_for("MarginPopup")]  = self:_action("v_margin_popup"),
         [popups.mapping_for("MergePopup")]      = self:_action("v_merge_popup"),
         [popups.mapping_for("PullPopup")]       = self:_action("v_pull_popup"),
         [popups.mapping_for("PushPopup")]       = self:_action("v_push_popup"),
@@ -182,6 +183,7 @@ function M:open(kind)
         [popups.mapping_for("HelpPopup")]       = self:_action("n_help_popup"),
         [popups.mapping_for("IgnorePopup")]     = self:_action("n_ignore_popup"),
         [popups.mapping_for("LogPopup")]        = self:_action("n_log_popup"),
+        [popups.mapping_for("MarginPopup")]  = self:_action("n_margin_popup"),
         [popups.mapping_for("MergePopup")]      = self:_action("n_merge_popup"),
         [popups.mapping_for("PullPopup")]       = self:_action("n_pull_popup"),
         [popups.mapping_for("PushPopup")]       = self:_action("n_push_popup"),

lua/neogit/buffers/status/ui.lua

@@ -2,6 +2,7 @@ local Ui = require("neogit.lib.ui")
 local Component = require("neogit.lib.ui.component")
 local util = require("neogit.lib.util")
 local common = require("neogit.buffers.common")
+local config = require("neogit.config")
 local a = require("plenary.async")
 
 local col = Ui.col
@@ -359,6 +360,78 @@ local SectionItemCommit = Component.new(function(item)
     end
   end
 
+  -- Render date
+  if item.commit.rel_date:match(" years?,") then
+    item.commit.rel_date, _ = item.commit.rel_date:gsub(" years?,", "y")
+    item.commit.rel_date = item.commit.rel_date .. " "
+  elseif item.commit.rel_date:match("^%d ") then
+    item.commit.rel_date = " " .. item.commit.rel_date
+  end
+
+  -- Render author and date in margin
+  local state = require("neogit.lib.state")
+  local visibility = state.get({ "margin", "visibility" }, false)
+  local margin_date_style = state.get({ "margin", "date_style" }, 1)
+  local details = state.get({ "margin", "details" }, false)
+  local date
+  local author_table = { "" }
+  local date_table
+  local date_width = 10
+  local clamp_width = 30 -- to avoid having too much space when relative date is short
+
+  if margin_date_style == 1 then -- relative date (short)
+    local unpacked = vim.split(item.commit.rel_date, " ")
+    -- above, we added a space if the rel_date started with a single number
+    -- we get the last two elements to deal with that
+    local date_number = unpacked[#unpacked - 1]
+    local date_quantifier = unpacked[#unpacked]
+    if date_quantifier:match("months?") then
+      date_quantifier = date_quantifier:gsub("m", "M") -- to distinguish from minutes
+    end
+    -- add back the space if we have a single number
+    local left_pad
+    if #unpacked > 2 then
+      left_pad = " "
+    else
+      left_pad = ""
+    end
+    date = left_pad .. date_number .. date_quantifier:sub(1, 1)
+    date_width = 3
+    clamp_width = 23
+  elseif margin_date_style == 2 then -- relative date (long)
+    date = item.commit.rel_date
+    date_width = 10
+  else -- local iso date
+    if config.values.log_date_format == nil then
+      -- we get the unix date to be able to convert the date to
+      -- the local timezone
+      date = os.date("%Y-%m-%d %H:%M", item.commit.unix_date)
+      date_width = 16 -- TODO: what should the width be here?
+    else
+      date = item.commit.log_date
+      date_width = 16
+    end
+  end
+
+  date_table = { util.str_min_width(date, date_width), "Special" }
+
+  if details then
+    author_table = {
+      util.str_clamp(item.commit.author_name, clamp_width - (#date > date_width and #date or date_width)),
+      "NeogitGraphAuthor",
+    }
+  end
+
+  if visibility then
+    Virt = {
+      { " ", "Constant" },
+      author_table,
+      date_table,
+    }
+  else
+    Virt = {}
+  end
+
   return row(
     util.merge(
       { text.highlight("NeogitObjectId")(item.commit.abbreviated_commit) },
@@ -367,7 +440,12 @@ local SectionItemCommit = Component.new(function(item)
       ref_last,
       { text(item.commit.subject) }
     ),
-    { oid = item.commit.oid, yankable = item.commit.oid, item = item }
+    {
+      virtual_text = Virt,
+      oid = item.commit.oid,
+      yankable = item.commit.oid,
+      item = item,
+    }
   )
 end)
 

lua/neogit/config.lua

@@ -238,6 +238,7 @@ end
 ---| "PushPopup"
 ---| "CommitPopup"
 ---| "LogPopup"
+---| "MarginPopup"
 ---| "RevertPopup"
 ---| "StashPopup"
 ---| "IgnorePopup"
@@ -626,6 +627,7 @@ function M.get_default_values()
         ["c"] = "CommitPopup",
         ["f"] = "FetchPopup",
         ["l"] = "LogPopup",
+        ["L"] = "MarginPopup",
         ["m"] = "MergePopup",
         ["p"] = "PullPopup",
         ["r"] = "RebasePopup",

lua/neogit/lib/git/log.lua

@@ -30,6 +30,7 @@ local commit_header_pat = "([| ]*)(%*?)([| ]*)commit (%w+)"
 ---@field verification_flag string?
 ---@field rel_date string
 ---@field log_date string
+---@field unix_date string
 
 ---Parses the provided list of lines into a CommitLogEntry
 ---@param raw string[]
@@ -340,6 +341,7 @@ local function format(show_signature)
     committer_date = "%cD",
     rel_date = "%cr",
     log_date = "%cd",
+    unix_date = "%ct",
   }
 
   if show_signature then

lua/neogit/popups/help/actions.lua

@@ -75,6 +75,9 @@ M.popups = function(env)
     { "LogPopup", "Log", popups.open("log", function(p)
       p(env.log)
     end) },
+    { "MarginPopup", "Margin", popups.open("margin", function(p)
+      p(env.log)
+    end) },
     {
       "CherryPickPopup",
       "Cherry Pick",

lua/neogit/popups/margin/actions.lua

@@ -0,0 +1,25 @@
+local M = {}
+
+local state = require("neogit.lib.state")
+
+function M.toggle_visibility()
+  local visibility = state.get({ "margin", "visibility" }, false)
+  local new_visibility = not visibility
+  state.set({ "margin", "visibility" }, new_visibility)
+end
+
+function M.cycle_date_style()
+  local styles = { "relative_short", "relative_long", "local_datetime" }
+  local current_index = state.get({ "margin", "date_style" }, #styles)
+  local next_index = (current_index % #styles) + 1 -- wrap around to the first style
+
+  state.set({ "margin", "date_style" }, next_index)
+end
+
+function M.toggle_details()
+  local details = state.get({ "margin", "details" }, false)
+  local new_details = not details
+  state.set({ "margin", "details" }, new_details)
+end
+
+return M

lua/neogit/popups/margin/init.lua

@@ -0,0 +1,49 @@
+local popup = require("neogit.lib.popup")
+local config = require("neogit.config")
+local actions = require("neogit.popups.margin.actions")
+
+local M = {}
+
+function M.create(env)
+  local p = popup
+    .builder()
+    :name("NeogitMarginPopup")
+    :option("n", "max-count", "256", "Limit number of commits", { default = "256", key_prefix = "-" })
+    :switch("o", "topo", "Order commits by", {
+      cli_suffix = "-order",
+      options = {
+        { display = "", value = "" },
+        { display = "topo", value = "topo" },
+        { display = "author-date", value = "author-date" },
+        { display = "date", value = "date" },
+      },
+    })
+    :switch("g", "graph", "Show graph", {
+      enabled = true,
+      internal = true,
+      incompatible = { "reverse" },
+      dependent = { "color" },
+    })
+    :switch_if(
+      config.values.graph_style == "ascii" or config.values.graph_style == "kitty",
+      "c",
+      "color",
+      "Show graph in color",
+      { internal = true, incompatible = { "reverse" } }
+    )
+    :switch("d", "decorate", "Show refnames", { enabled = true, internal = true })
+    :group_heading("Refresh")
+    :action("g", "buffer", actions.log_current)
+    :new_action_group("Margin")
+    :action("L", "toggle visibility", actions.toggle_visibility)
+    :action("l", "cycle style", actions.cycle_date_style)
+    :action("d", "toggle details", actions.toggle_details)
+    :action("x", "toggle shortstat", actions.log_current)
+    :build()
+
+  p:show()
+
+  return p
+end
+
+return M