feat: commit component

README.md

@@ -251,6 +251,7 @@ sections = {lualine_a = {'mode'}}
 #### Available components
 
 - `branch` (git branch)
+- `commit` (git commit difference between current branch and remote or master)
 - `buffers` (shows currently available buffers)
 - `diagnostics` (diagnostics count from your preferred source)
 - `diff` (git diff status)
@@ -773,6 +774,30 @@ sections = {
 }
 ```
 
+#### commit component options
+
+```lua
+sections = {
+  lualine_a = {
+    {
+      'commit',
+      icon = '', -- Component icon
+      master_name = 'master', -- Default master branch name, some repositories use `main`.
+      colored = true, -- Set to true displays safe to merge commits and conflicts in color.
+      findout_master_name = false, -- Let's the component get the master branch name from origin HEAD branch.
+      diff_against_master = false, -- Compare current branch to remote and master branch.
+      fetch_interval = 60000, -- How ofter `git fetch` is done, in ms.
+      unpulled_master_icon = '⇢ ', -- Icon shown for unpulled changes from master branch.
+      unpulled_icon = '⇣ ', -- Icon shown for unpulled changes on current branch.
+      unpushed_icon = '⇡ ', -- Icon shown for unpushed changes on current branch.
+      use_check_icon = true, -- Use checkmark icon, instead of `0`.
+      check_icon = '󰸞', -- Icon to display check mark instead of `0`.
+      show_only_diverged = true, -- Don't show `0` or check mark if up to date.
+    }
+  }
+}
+```
+
 ---
 
 ### Tabline

lua/lualine/components/commit/find_git_dir.lua

@@ -0,0 +1,54 @@
+-- os specific path separator
+local sep = package.config:sub(1, 1)
+
+local git_dir_cache = {} -- Stores git paths that we already know of, map file dir to git_dir
+
+-- function taken from ../branch/git_branch.lua module. Code was adjusted to
+-- remove setting current_git_dir global variable and remove update_branch()
+-- call (component specific).
+local function find_git_dir(dir_path)
+  -- get file dir so we can search from that dir
+  local file_dir = dir_path or vim.fn.expand('%:p:h')
+  local root_dir = file_dir
+  local git_dir
+  -- Search upward for .git file or folder
+  while root_dir do
+    if git_dir_cache[root_dir] then
+      git_dir = git_dir_cache[root_dir]
+      break
+    end
+    local git_path = root_dir .. sep .. '.git'
+    local git_file_stat = vim.loop.fs_stat(git_path)
+    if git_file_stat then
+      if git_file_stat.type == 'directory' then
+        git_dir = git_path
+      elseif git_file_stat.type == 'file' then
+        -- separate git-dir or submodule is used
+        local file = io.open(git_path)
+        if file then
+          git_dir = file:read()
+          git_dir = git_dir and git_dir:match('gitdir: (.+)$')
+          file:close()
+        end
+        -- submodule / relative file path
+        if git_dir and git_dir:sub(1, 1) ~= sep and not git_dir:match('^%a:.*$') then
+          git_dir = git_path:match('(.*).git') .. git_dir
+        end
+      end
+      if git_dir then
+        local head_file_stat = vim.loop.fs_stat(git_dir .. sep .. 'HEAD')
+        if head_file_stat and head_file_stat.type == 'file' then
+          break
+        else
+          git_dir = nil
+        end
+      end
+    end
+    root_dir = root_dir:match('(.*)' .. sep .. '.-')
+  end
+
+  git_dir_cache[file_dir] = git_dir
+  return git_dir
+end
+
+return find_git_dir

lua/lualine/components/commit/init.lua

@@ -0,0 +1,130 @@
+local M = require('lualine.component'):extend()
+local modules = require('lualine_require').lazy_require {
+  status = 'lualine.components.commit.status',
+  utils = 'lualine.utils.utils',
+}
+
+local default_options = {
+  icon = '',
+  master_name = 'master',
+  colored = true,
+  findout_master_name = false,
+  diff_against_master = false,
+  fetch_interval = 60000,
+  unpulled_master_icon = '⇢ ',
+  unpulled_icon = '⇣ ',
+  unpushed_icon = '⇡ ',
+  use_check_icon = true,
+  check_icon = '󰸞',
+  show_only_diverged = true,
+}
+
+local function apply_default_colors(opts)
+  local default_color = {
+    insync = {
+      fg = modules.utils.extract_color_from_hllist('fg', { 'lualine_a_inactive' }, '#90ee90'),
+    },
+    diverged = {
+      fg = modules.utils.extract_color_from_hllist(
+        'fg',
+        { 'GitSignsChange', 'GitGutterChange', 'DiffChanged', 'DiffChange' },
+        '#f0e130'
+      ),
+    },
+    conflict = {
+      fg = modules.utils.extract_color_from_hllist(
+        'fg',
+        { 'GitSignsDelete', 'GitGutterDelete', 'DiffRemoved', 'DiffDelete' },
+        '#ff0038'
+      ),
+    },
+  }
+  opts.color = vim.tbl_deep_extend('keep', opts.color or {}, default_color)
+end
+
+-- Initializer
+M.init = function(self, options)
+  M.super.init(self, options)
+  apply_default_colors(self.options)
+  self.options = vim.tbl_deep_extend('keep', self.options or {}, default_options)
+
+  if self.options.colored then
+    self.highlights = {
+      insync = self:create_hl(self.options.color.insync, 'insync'),
+      diverged = self:create_hl(self.options.color.diverged, 'diverged'),
+      conflict = self:create_hl(self.options.color.conflict, 'conflict'),
+    }
+  end
+
+  modules.status.init {
+    master_name = self.options.master_name,
+    findout_master_name = self.options.findout_master_name,
+    diff_against_master = self.options.diff_against_master,
+    fetch_interval = self.options.fetch_interval,
+  }
+end
+
+function M:update_status(_, is_focused)
+  local buf = (not is_focused and vim.api.nvim_get_current_buf())
+
+  local colors = {}
+  if self.options.colored then
+    -- load the highlights and store them in colors table
+    for name, highlight_name in pairs(self.highlights) do
+      colors[name] = self:format_hl(highlight_name)
+    end
+  end
+
+  local status = modules.status.status(buf)
+  local result = {}
+  local icons = {
+    self.options.unpulled_master_icon,
+    self.options.unpulled_icon,
+    self.options.unpushed_icon,
+  }
+
+  if not self.options.diff_against_master then
+    table.remove(status, 1)
+  end
+
+  for k, v in ipairs(status) do
+    local has_conflict = table.remove(v)
+    for k2, d in ipairs(v) do
+      if not (self.options.show_only_diverged and d == 0) and d ~= -1 then
+        local count = tostring(d)
+        if self.options.use_check_icon then
+          if d == 0 then
+            count = self.options.check_icon
+          end
+        end
+
+        local icon_pos
+        if not self.options.diff_against_master then
+          icon_pos = k2 + 1
+        else
+          if k == 1 then
+            icon_pos = 1
+          else
+            icon_pos = k2 + 1
+          end
+        end
+
+        local icon = icons[icon_pos]
+        if self.options.colored then
+          local color = (d > 0) and colors['diverged'] or colors['insync']
+          if has_conflict then
+            color = colors['conflict']
+          end
+
+          table.insert(result, color .. icon .. count .. (has_conflict and '!' or ''))
+        else
+          table.insert(result, icon .. count .. (has_conflict and '!' or ''))
+        end
+      end
+    end
+  end
+
+  return table.concat(result, ' ')
+end
+
+return M

lua/lualine/components/commit/jobs.lua

@@ -0,0 +1,91 @@
+local job = require('lualine.utils.job')
+
+local M = {}
+
+function M._run_job(cmd, cwd, callback)
+  local output = ''
+  local err = ''
+
+  local j = job {
+    cmd = cmd,
+    cwd = cwd,
+    stdout_buffered = true,
+    stderr_buffered = true,
+    on_stdout = function(_, data)
+      output = table.concat(data, '\n')
+    end,
+    on_stderr = function(_, data)
+      err = table.concat(data, '\n')
+    end,
+    on_exit = function(_, exit_code)
+      callback(exit_code, output, err)
+    end,
+  }
+
+  if j then
+    j:start()
+  end
+end
+
+function M.check_origin(cwd, callback)
+  M._run_job([[git remote show]], cwd, function(exit_code, output, _)
+    output = output:gsub('\n', '')
+    if exit_code ~= 0 or output ~= 'origin' then
+      callback(false)
+      return
+    end
+
+    callback(true)
+  end)
+end
+
+function M.get_master_name(cwd, callback)
+  M._run_job([[git remote show origin]], cwd, function(exit_code, output, _)
+    if exit_code ~= 0 then
+      callback(false)
+      return
+    end
+    local _, _, name = string.find(output, "HEAD branch: (%S+)")
+    callback(true, name)
+  end)
+end
+
+function M.fetch_branch(cwd, name, callback)
+  local cmd = string.format([[git fetch origin %s]], name)
+  M._run_job(cmd, cwd, function(exit_code, _, _)
+    if exit_code ~= 0 then
+      callback(false)
+      return
+    end
+    callback(true)
+  end)
+end
+
+function M.check_for_conflict(cwd, source, target, callback)
+  local cmd = string.format(
+    [[git merge-tree `git merge-base %s %s` %s %s]],
+    source, target, target, source)
+  M._run_job(cmd, cwd, function(exit_code, output, _)
+    if exit_code ~= 0 then
+      callback(true, false)
+      return
+    end
+
+    local found = string.find(output, "<<<<<<<")
+    callback(true, found ~= nil)
+  end)
+end
+
+function M.commit_diff(cwd, source, target, callback)
+  local cmd = string.format([[git rev-list --count --left-right %s %s]], source, target)
+  M._run_job(cmd, cwd, function(exit_code, output, err)
+    if exit_code ~= 0 then
+      callback(false, -1, err)
+      return
+    end
+    local commit_count = string.match(output, "%d+	(%d+)")
+    callback(true, tonumber(commit_count))
+  end)
+end
+
+return M