feat(extras): add vim colorscheme to extras

Author: mehalter

lua/astrotheme/extras/init.lua

@@ -5,15 +5,16 @@
 local M = {}
 
 -- map of plugin name to plugin extension
---- @type table<string, {ext:string, url:string, label:string, subdir?: string, sep?:string}>
+--- @type table<string, {ext:string, url:string, label:string, subdir?: string}>
 -- stylua: ignore
 M.extras = {
   -- Keep all entries here aligned by the first `=` sign
   wezterm = { ext = "toml", url = "https://wezfurlong.org/wezterm/config/files.html", label = "WezTerm" },
+  vim     = { ext = "vim", url = "https://vimhelp.org/", label = "Vim", subdir = "colors"},
 }
 
 function M.setup()
-  local config, util = require("astrotheme").config, require "astrotheme.lib.util"
+  local util = require "astrotheme.lib.util"
 
   -- map of style to style name
   local palettes = {
@@ -31,16 +32,11 @@ function M.setup()
     local info = M.extras[extra]
     local plugin = require("astrotheme.extras." .. extra)
     for palette, palette_name in pairs(palettes) do
+      local config = require("astrotheme.lib.config").default
       config.palette, config.plugin_default = palette, true
       local colors = util.set_palettes(config)
       local highlights = util.get_highlights(colors, config)
-      local fname = extra
-        .. (info.subdir and "/" .. info.subdir .. "/" or "")
-        .. "/astrotheme"
-        .. (info.sep or "_")
-        .. palette
-        .. "."
-        .. info.ext
+      local fname = extra .. (info.subdir and "/" .. info.subdir or "") .. "/" .. palette .. "." .. info.ext
       colors["_upstream_url"] = "https://github.com/AstroNvim/astrotheme/raw/main/extras/" .. fname
       colors["_style_name"] = "AstroTheme " .. palette_name
       colors["_name"] = "astrotheme_" .. palette

lua/astrotheme/extras/vim.lua

@@ -0,0 +1,90 @@
+local M = {}
+
+local mapping = {
+  fg = "guifg",
+  bg = "guibg",
+  sp = "guisp",
+}
+
+--- @param colors AstroThemePalette
+--- @param highlights table<string, vim.api.keyset.highlight>
+--- @param opts AstroThemeOpts
+function M.generate(colors, highlights, opts)
+  opts.plugin_default = false
+  for p, n in pairs(require "astrotheme.groups.plugins") do
+    if not p:find "nvim" then opts.plugins[n] = true end
+  end
+  highlights = require("astrotheme.lib.util").get_highlights(colors, opts)
+  local lines = {
+    ([[
+let g:colors_name = "%s"
+hi clear
+  ]]):format(colors._style),
+  }
+
+  highlights = vim.deepcopy(highlights)
+  for name in pairs(highlights) do
+    if name:sub(1, 1) == "@" then highlights[name] = nil end
+  end
+  local names = vim.tbl_keys(highlights)
+  table.sort(names)
+
+  local used = {}
+  for _, name in ipairs(names) do
+    local hl = highlights[name]
+    if type(hl) == "string" then hl = { link = hl } end
+
+    if not hl.link then
+      local props = {}
+
+      -- fg/bg/sp
+      for k, v in pairs(hl) do
+        if mapping[k] then props[#props + 1] = ("%s=%s"):format(mapping[k], v) end
+      end
+
+      -- gui
+      local gui = {}
+      for _, attr in ipairs {
+        "bold",
+        "underline",
+        "undercurl",
+        "italic",
+        "strikethrough",
+        "underdouble",
+        "underdotted",
+        "underdashed",
+        "inverse",
+        "standout",
+        "nocombine",
+        "altfont",
+      } do
+        if hl[attr] then gui[#gui + 1] = attr end
+      end
+      if #gui > 0 then props[#props + 1] = ("gui=%s"):format(table.concat(gui, ",")) end
+
+      if #props > 0 then
+        if not hl.bg then props[#props + 1] = "guibg=NONE" end
+        table.sort(props)
+        used[name] = true
+        lines[#lines + 1] = ("hi %s %s"):format(name, table.concat(props, " "))
+      else
+        print("astrotheme: invalid highlight group: " .. name)
+      end
+    end
+  end
+
+  for _, name in ipairs(names) do
+    local hl = highlights[name]
+    if type(hl) == "string" then hl = { link = hl } end
+
+    if hl.link then
+      if hl.link:sub(1, 1) ~= "@" and highlights[hl.link] and used[hl.link] then
+        lines[#lines + 1] = ("hi! link %s %s"):format(name, hl.link)
+      end
+    end
+  end
+
+  return table.concat(lines, "\n")
+end
+
+return M

lua/astrotheme/types.lua

@@ -73,6 +73,10 @@
 ---@field syntax AstroThemePaletteSyntax? Colors that control syntax related highlight groups
 ---@field term AstroThemePaletteTerm? Colors that control colors set for in-editor terminals
 ---@field ui AstroThemePaletteUI? Colors that are used throughout the general user interface
+---@field _upstream_url string?
+---@field _style_name string?
+---@field _name string?
+---@field _style string?
 
 ---@class AstroThemeHighlightOpts
 ---@field modify_hl_groups fun(hl: AstroThemeHighlights, c: AstroThemePalette)? Function for fine control over highlight setting. The first parameter is the table of highlights to modify directly, the second is the current palette of colors