feat(#2415): colour and highlight overhaul, see :help nvim-tree-highlight-overhaul (#2455)

* feat(#2415): granular highlight_diagnostics, normalise groups (#2454) * chore: normalise colours and enable cterm (#2471) * feat(#2415): granular highlight_git, normalise git groups (#2487) * docs: update CONTRIBUTING.md (#2485) * feat(#2415): granular highlight_git, normalise git groups * feat(#2415): normalise and add modified groups * feat(#2415): create Decorator class for modified and bookmarks * feat(#2415): create DecoratorDiagnostics * feat(#2415): create DecoratorGit * feat(#2415): create DecoratorGit * add DecoratorCopied DecoratorCut * add DecoratorOpened * remove unloaded_bufnr checks as the view debouncer takes care of it * Add `renderer.highlight_git` to accepted strings * fix(#2415): builder refactor (#2538) * simplify builder signs * decorators take care of themselves and are priority ordered * simplify builder hl groups * refactor builder for icon arrays * builder use decorators generically * fix(#2415): harden sign creation (#2539) * fix(#2415): harden unicode signs * Decorator tidy * normalise git sign creation and tidy * tidy builder * NvimTreeBookmarkIcon * tidy HL doc * tidy HL doc * tidy HL doc * tidy builder doc * standardise on '---@param' * DiagnosticWarning -> DiagnosticWarn * annotate decorators * limit to two highlight groups for line rendering * style * apply #2519 * feat(#2415): combined hl groups (#2601) * feat(#2415): create combined highlight groups * feat(#2415): create combined highlight groups * feat(#2415): create combined highlight groups * ci: allow workflow_dispatch (#2620) * one and only one hl namespace, required winhl removal * small tidies * colors.lua -> appearance.lua * full-name uses one and only namespace * don't highlight fast, just apply to namespace, safer win_set_hl * gut builder (#2622) collapse Builder * fix group_empty function check * feat(#2415): highlight-overhaul release date --------- Co-authored-by: Akmadan23 <azadahmadi@mailo.com>
2024-01-20 16:12:13 +11:00
parent f24afa2cef
commit e9c5abe073
30 changed files with 1468 additions and 1004 deletions
--- a/lua/nvim-tree/renderer/decorator/init.lua
+++ b/lua/nvim-tree/renderer/decorator/init.lua
@@ -0,0 +1,122 @@
+local HL_POSITION = require("nvim-tree.enum").HL_POSITION
+local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
+
+---@class Decorator
+---@field protected enabled boolean
+---@field protected hl_pos HL_POSITION
+---@field protected icon_placement ICON_PLACEMENT
+local Decorator = {}
+
+---@param o Decorator|nil
+---@return Decorator
+function Decorator:new(o)
+  o = o or {}
+  setmetatable(o, self)
+  self.__index = self
+
+  return o
+end
+
+---Maybe highlight groups
+---@param node Node
+---@return string|nil icon highlight group
+---@return string|nil name highlight group
+function Decorator:groups_icon_name(node)
+  local icon_hl, name_hl
+
+  if self.enabled and self.hl_pos ~= HL_POSITION.none then
+    local hl = self:calculate_highlight(node)
+
+    if self.hl_pos == HL_POSITION.all or self.hl_pos == HL_POSITION.icon then
+      icon_hl = hl
+    end
+    if self.hl_pos == HL_POSITION.all or self.hl_pos == HL_POSITION.name then
+      name_hl = hl
+    end
+  end
+
+  return icon_hl, name_hl
+end
+
+---Maybe icon sign
+---@param node Node
+---@return string|nil name
+function Decorator:sign_name(node)
+  if not self.enabled or self.icon_placement ~= ICON_PLACEMENT.signcolumn then
+    return
+  end
+
+  local icons = self:calculate_icons(node)
+  if icons and #icons > 0 then
+    return icons[1].hl[1]
+  end
+end
+
+---Icons when ICON_PLACEMENT.before
+---@param node Node
+---@return HighlightedString[]|nil icons
+function Decorator:icons_before(node)
+  if not self.enabled or self.icon_placement ~= ICON_PLACEMENT.before then
+    return
+  end
+
+  return self:calculate_icons(node)
+end
+
+---Icons when ICON_PLACEMENT.after
+---@param node Node
+---@return HighlightedString[]|nil icons
+function Decorator:icons_after(node)
+  if not self.enabled or self.icon_placement ~= ICON_PLACEMENT.after then
+    return
+  end
+
+  return self:calculate_icons(node)
+end
+
+---Maybe icons, optionally implemented
+---@protected
+---@param _ Node
+---@return HighlightedString[]|nil icons
+function Decorator:calculate_icons(_)
+  return nil
+end
+
+---Maybe highlight group, optionally implemented
+---@protected
+---@param _ Node
+---@return string|nil group
+function Decorator:calculate_highlight(_)
+  return nil
+end
+
+---Define a sign
+---@protected
+---@param icon HighlightedString|nil
+function Decorator:define_sign(icon)
+  if icon and #icon.hl > 0 then
+    local name = icon.hl[1]
+
+    if not vim.tbl_isempty(vim.fn.sign_getdefined(name)) then
+      vim.fn.sign_undefine(name)
+    end
+
+    -- don't use sign if not defined
+    if #icon.str < 1 then
+      self.icon_placement = ICON_PLACEMENT.none
+      return
+    end
+
+    -- byte index of the next character, allowing for wide
+    local bi = vim.fn.byteidx(icon.str, 1)
+
+    -- first (wide) character, falls back to empty string
+    local text = string.sub(icon.str, 1, bi)
+    vim.fn.sign_define(name, {
+      text = text,
+      texthl = name,
+    })
+  end
+end
+
+return Decorator