feat: add Lazygit theming integration

Author: mehalter

README.md

@@ -113,6 +113,22 @@ require("astroui").setup({
       },
     },
   },
+  -- Configure theming of Lazygit, set to `false` to disable
+  lazygit = {
+    theme_path = vim.fs.normalize(vim.fn.stdpath "cache" .. "/lazygit-theme.yml"),
+    theme = {
+      [241] = { fg = "Special" },
+      activeBorderColor = { fg = "MatchParen", bold = true },
+      cherryPickedCommitBgColor = { fg = "Identifier" },
+      cherryPickedCommitFgColor = { fg = "Function" },
+      defaultFgColor = { fg = "Normal" },
+      inactiveBorderColor = { fg = "FloatBorder" },
+      optionsTextColor = { fg = "Function" },
+      searchingActiveBorderColor = { fg = "MatchParen", bold = true },
+      selectedLineBgColor = { bg = "Visual" },
+      unstagedChangesColor = { fg = "DiagnosticError" },
+    },
+  },
 }
 ```
 

lua/astroui/config.lua

@@ -29,6 +29,11 @@
 ---```
 ---@field file_icon AstroUIFileIconHighlights?
 
+---@class AstroUILazygitOpts
+---@field theme_path string? the path to the storage location for the lazygit theme configuration
+---@field theme table<string|number,{fg:string?,bg:string?,bold:boolean?,reverse:boolean?,underline:boolean?,strikethrough:boolean?}>? table of highlight groups to use for the lazygit theme
+---@field config table? arbitrary lazygit configuration structure
+
 ---@class AstroUISeparators
 ---@field none string[]? placeholder separator for elements with "no" separator, typically two empty strings
 ---@field left string[]? Separators used for elements designated as being on the left of the statusline
@@ -187,6 +192,28 @@
 ---}
 ---```
 ---@field status AstroUIStatusOpts?
+---Configuration options for the Lazygit theme integration
+---Example:
+---
+---```lua
+---lazygit = {
+---  theme_path = vim.fs.normalize(vim.fn.stdpath "cache" .. "/lazygit-theme.yml"),
+---  config = { os = { editPreset = "nvim-remote" } },
+---  theme = {
+---    [241] = { fg = "Special" },
+---    activeBorderColor = { fg = "MatchParen", bold = true },
+---    cherryPickedCommitBgColor = { fg = "Identifier" },
+---    cherryPickedCommitFgColor = { fg = "Function" },
+---    defaultFgColor = { fg = "Normal" },
+---    inactiveBorderColor = { fg = "FloatBorder" },
+---    optionsTextColor = { fg = "Function" },
+---    searchingActiveBorderColor = { fg = "MatchParen", bold = true },
+---    selectedLineBgColor = { bg = "Visual" },
+---    unstagedChangesColor = { fg = "DiagnosticError" },
+---  },
+---}
+---```
+---@field lazygit AstroUILazygitOpts?
 
 ---@type AstroUIOpts
 local M = {
@@ -205,6 +232,7 @@ local M = {
     sign_handlers = {},
     winbar = {},
   },
+  lazygit = false,
 }
 
 return M

lua/astroui/init.lua

@@ -37,6 +37,8 @@ function M.setup(opts)
   if colorscheme and not pcall(vim.cmd.colorscheme, colorscheme) then
     vim.notify(("Error setting up colorscheme: `%s`"):format(colorscheme), vim.log.levels.ERROR, { title = "AstroUI" })
   end
+
+  require("astroui.lazygit").setup()
 end
 
 --- Get highlight properties for a given highlight name

lua/astroui/lazygit.lua

@@ -0,0 +1,77 @@
+--- Adapted from folke's snack.nvim lazygit integration:
+--- https://github.com/folke/snacks.nvim/blob/14c787540828946126f2acb5e542dc57956c2711/lua/snacks/lazygit.lua
+local M = {}
+
+local astroui = require "astroui"
+local config = astroui.config.lazygit
+
+-- Build theme configuration file
+function M.update_config()
+  if not config then return end
+  ---@type table<string, string[]>
+  local theme = {}
+
+  for k, v in pairs(config.theme or {}) do
+    local color = {}
+    for _, c in ipairs { "fg", "bg" } do
+      if v[c] then
+        local hl_color = astroui.get_hlgroup(v[c] --[[ @as string ]])[c]
+        if type(hl_color) == "number" then table.insert(color, string.format("#%06x", hl_color)) end
+      end
+    end
+    for _, modifier in ipairs { "bold", "reverse", "underline", "strikethrough" } do
+      if v[modifier] then table.insert(color, modifier) end
+    end
+    if type(k) == "number" then
+      pcall(io.write, ("\27]4;%d;%s\7"):format(k, color[1]))
+    else
+      theme[k] = color
+    end
+  end
+
+  local lg_config = vim.tbl_deep_extend("force", { gui = { theme = theme } }, config.config or {})
+
+  local function yaml_val(val) return type(val) == "string" and not val:find "^\"'`" and ("%q"):format(val) or val end
+
+  local function to_yaml(tbl, indent)
+    indent = indent or 0
+    local lines = {}
+    for k, v in pairs(tbl) do
+      table.insert(lines, string.rep(" ", indent) .. k .. (type(v) == "table" and ":" or ": " .. yaml_val(v)))
+      if type(v) == "table" then
+        if (vim.islist or vim.tbl_islist)(v) then
+          for _, item in ipairs(v) do
+            table.insert(lines, string.rep(" ", indent + 2) .. "- " .. yaml_val(item))
+          end
+        else
+          vim.list_extend(lines, to_yaml(v, indent + 2))
+        end
+      end
+    end
+    return lines
+  end
+  vim.fn.writefile(to_yaml(lg_config), config.theme_path)
+end
+
+function M.setup()
+  if type(config) ~= "table" then return end
+
+  M.update_config()
+
+  local lg_config_file = vim.env.LG_CONFIG_FILE --[[ @as string? ]]
+  if not lg_config_file and vim.fn.executable "lazygit" == 1 then
+    lg_config_file = require("astrocore").cmd({ "lazygit", "-cd" }, false)
+    if lg_config_file then lg_config_file = vim.split(lg_config_file, "\n", { plain = true })[1] .. "/config.yml" end
+  end
+  lg_config_file = lg_config_file and lg_config_file .. "," or ""
+  vim.env.LG_CONFIG_FILE = vim.fs.normalize(lg_config_file .. config.theme_path)
+
+  vim.api.nvim_create_autocmd("User", {
+    pattern = "AstroColorScheme",
+    callback = M.update_config,
+    desc = "Update lazygit theme configuration when changing colorscheme",
+    group = vim.api.nvim_create_augroup("astroui_lazygit", { clear = true }),
+  })
+end
+
+return M