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/components/bookmarks.lua
+++ b/lua/nvim-tree/renderer/components/bookmarks.lua
@@ -1,51 +0,0 @@
-local marks = require "nvim-tree.marks"
-
-local HL_POSITION = require("nvim-tree.enum").HL_POSITION
-
-local M = {
-  ICON = {},
-  hl_pos = HL_POSITION.none,
-}
-
---Bookmark highlight group and position when highlight_bookmark.
---@param node table
---@return HL_POSITION position none when clipboard empty
---@return string|nil group only when node present in clipboard
-function M.get_highlight(node)
-  if M.hl_pos == HL_POSITION.none then
-    return HL_POSITION.none, nil
-  end
-
-  local mark = marks.get_mark(node)
-  if mark then
-    return M.hl_pos, "NvimTreeBookmarkHL"
-  else
-    return HL_POSITION.none, nil
-  end
-end
-
---bookmark icon if marked
---@param node table
---@return HighlightedString|nil bookmark icon
-function M.get_icon(node)
-  if M.config.renderer.icons.show.bookmarks and marks.get_mark(node) then
-    return M.ICON
-  end
-end
-
-function M.setup(opts)
-  M.config = {
-    renderer = opts.renderer,
-  }
-
-  M.hl_pos = HL_POSITION[opts.renderer.highlight_bookmarks] or HL_POSITION.none
-
-  M.ICON = {
-    str = opts.renderer.icons.glyphs.bookmark,
-    hl = { "NvimTreeBookmark" },
-  }
-
-  vim.fn.sign_define(M.ICON.hl[1], { text = M.ICON.str, texthl = M.ICON.hl[1] })
-end
-
-return M
--- a/lua/nvim-tree/renderer/components/diagnostics.lua
+++ b/lua/nvim-tree/renderer/components/diagnostics.lua
@@ -2,18 +2,23 @@ local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local diagnostics = require "nvim-tree.diagnostics"

 local M = {
-  HS_FILE = {},
-  HS_FOLDER = {},
-  ICON = {},
-  hl_pos = HL_POSITION.none,
+  -- highlight strings for the icons
+  HS_ICON = {},
+
+  -- highlight groups for HL
+  HG_FILE = {},
+  HG_FOLDER = {},
+
+  -- position for HL
+  HL_POS = HL_POSITION.none,
 }

---Diagnostics text highlight group when highlight_diagnostics.
+---Diagnostics highlight group and position when highlight_diagnostics.
 ---@param node table
 ---@return HL_POSITION position none when no status
 ---@return string|nil group only when status
 function M.get_highlight(node)
-  if not node or M.hl_pos == HL_POSITION.none then
+  if not node or M.HL_POS == HL_POSITION.none then
    return HL_POSITION.none, nil
  end

@@ -26,7 +31,7 @@ function M.get_highlight(node)
  end

  if group then
-    return M.hl_pos, group
+    return M.HL_POS, group
  else
    return HL_POSITION.none, nil
  end
@@ -49,40 +54,38 @@ function M.setup(opts)
  }

  if opts.diagnostics.enable and opts.renderer.highlight_diagnostics then
-    -- TODO add a HL_POSITION
-    -- M.hl_pos = HL_POSITION[opts.renderer.highlight_diagnostics]
-    M.hl_pos = HL_POSITION.name
+    M.HL_POS = HL_POSITION[opts.renderer.highlight_diagnostics]
  end

-  M.HS_FILE[vim.diagnostic.severity.ERROR] = "NvimTreeLspDiagnosticsErrorText"
-  M.HS_FILE[vim.diagnostic.severity.WARN] = "NvimTreeLspDiagnosticsWarningText"
-  M.HS_FILE[vim.diagnostic.severity.INFO] = "NvimTreeLspDiagnosticsInfoText"
-  M.HS_FILE[vim.diagnostic.severity.HINT] = "NvimTreeLspDiagnosticsHintText"
+  M.HG_FILE[vim.diagnostic.severity.ERROR] = "NvimTreeDiagnosticErrorFileHL"
+  M.HG_FILE[vim.diagnostic.severity.WARN] = "NvimTreeDiagnosticWarningFileHL"
+  M.HG_FILE[vim.diagnostic.severity.INFO] = "NvimTreeDiagnosticInfoFileHL"
+  M.HG_FILE[vim.diagnostic.severity.HINT] = "NvimTreeDiagnosticHintFileHL"

-  M.HS_FOLDER[vim.diagnostic.severity.ERROR] = "NvimTreeLspDiagnosticsErrorFolderText"
-  M.HS_FOLDER[vim.diagnostic.severity.WARN] = "NvimTreeLspDiagnosticsWarningFolderText"
-  M.HS_FOLDER[vim.diagnostic.severity.INFO] = "NvimTreeLspDiagnosticsInfoFolderText"
-  M.HS_FOLDER[vim.diagnostic.severity.HINT] = "NvimTreeLspDiagnosticsHintFolderText"
+  M.HG_FOLDER[vim.diagnostic.severity.ERROR] = "NvimTreeDiagnosticErrorFolderHL"
+  M.HG_FOLDER[vim.diagnostic.severity.WARN] = "NvimTreeDiagnosticWarningFolderHL"
+  M.HG_FOLDER[vim.diagnostic.severity.INFO] = "NvimTreeDiagnosticInfoFolderHL"
+  M.HG_FOLDER[vim.diagnostic.severity.HINT] = "NvimTreeDiagnosticHintFolderHL"

-  M.ICON[vim.diagnostic.severity.ERROR] = {
+  M.HS_ICON[vim.diagnostic.severity.ERROR] = {
    str = M.config.diagnostics.icons.error,
-    hl = { "NvimTreeLspDiagnosticsError" },
+    hl = { "NvimTreeDiagnosticErrorIcon" },
  }

-  M.ICON[vim.diagnostic.severity.WARN] = {
+  M.HS_ICON[vim.diagnostic.severity.WARN] = {
    str = M.config.diagnostics.icons.warning,
-    hl = { "NvimTreeLspDiagnosticsWarning" },
+    hl = { "NvimTreeDiagnosticWarningIcon" },
  }
-  M.ICON[vim.diagnostic.severity.INFO] = {
+  M.HS_ICON[vim.diagnostic.severity.INFO] = {
    str = M.config.diagnostics.icons.info,
-    hl = { "NvimTreeLspDiagnosticsInformation" },
+    hl = { "NvimTreeDiagnosticInfoIcon" },
  }
-  M.ICON[vim.diagnostic.severity.HINT] = {
+  M.HS_ICON[vim.diagnostic.severity.HINT] = {
    str = M.config.diagnostics.icons.hint,
-    hl = { "NvimTreeLspDiagnosticsHint" },
+    hl = { "NvimTreeDiagnosticHintIcon" },
  }

-  for _, i in ipairs(M.ICON) do
+  for _, i in ipairs(M.HS_ICON) do
    vim.fn.sign_define(i.hl[1], { text = i.str, texthl = i.hl[1] })
  end
 end
--- a/lua/nvim-tree/renderer/components/full-name.lua
+++ b/lua/nvim-tree/renderer/components/full-name.lua
@@ -1,3 +1,5 @@
+local appearance = require "nvim-tree.appearance"
+
 local M = {}

 local utils = require "nvim-tree.utils"
@@ -66,13 +68,12 @@ local function show()
    style = "minimal",
  })

-  local ns_id = vim.api.nvim_get_namespaces()["NvimTreeHighlights"]
-  local extmarks = vim.api.nvim_buf_get_extmarks(0, ns_id, { line_nr - 1, 0 }, { line_nr - 1, -1 }, { details = 1 })
+  local extmarks = vim.api.nvim_buf_get_extmarks(0, appearance.NS_ID, { line_nr - 1, 0 }, { line_nr - 1, -1 }, { details = 1 })
  vim.api.nvim_win_call(M.popup_win, function()
    vim.api.nvim_buf_set_lines(0, 0, -1, true, { line })
    for _, extmark in ipairs(extmarks) do
      local hl = extmark[4]
-      vim.api.nvim_buf_add_highlight(0, ns_id, hl.hl_group, 0, extmark[3], hl.end_col)
+      vim.api.nvim_buf_add_highlight(0, appearance.NS_ID, hl.hl_group, 0, extmark[3], hl.end_col)
    end
    vim.cmd [[ setlocal nowrap cursorline noswapfile nobuflisted buftype=nofile bufhidden=hide ]]
  end)
--- a/lua/nvim-tree/renderer/components/git.lua
+++ b/lua/nvim-tree/renderer/components/git.lua
@@ -1,191 +0,0 @@
-local notify = require "nvim-tree.notify"
-local explorer_node = require "nvim-tree.explorer.node"
-
-local M = {}
-
-local function build_icons_table(i)
-  local icons = {
-    staged = { str = i.staged, hl = { "NvimTreeGitStaged" }, ord = 1 },
-    unstaged = { str = i.unstaged, hl = { "NvimTreeGitDirty" }, ord = 2 },
-    renamed = { str = i.renamed, hl = { "NvimTreeGitRenamed" }, ord = 3 },
-    deleted = { str = i.deleted, hl = { "NvimTreeGitDeleted" }, ord = 4 },
-    unmerged = { str = i.unmerged, hl = { "NvimTreeGitMerge" }, ord = 5 },
-    untracked = { str = i.untracked, hl = { "NvimTreeGitNew" }, ord = 6 },
-    ignored = { str = i.ignored, hl = { "NvimTreeGitIgnored" }, ord = 7 },
-  }
-  return {
-    ["M "] = { icons.staged },
-    [" M"] = { icons.unstaged },
-    ["C "] = { icons.staged },
-    [" C"] = { icons.unstaged },
-    ["CM"] = { icons.unstaged },
-    [" T"] = { icons.unstaged },
-    ["T "] = { icons.staged },
-    ["TM"] = { icons.staged, icons.unstaged },
-    ["MM"] = { icons.staged, icons.unstaged },
-    ["MD"] = { icons.staged },
-    ["A "] = { icons.staged },
-    ["AD"] = { icons.staged },
-    [" A"] = { icons.untracked },
-    -- not sure about this one
-    ["AA"] = { icons.unmerged, icons.untracked },
-    ["AU"] = { icons.unmerged, icons.untracked },
-    ["AM"] = { icons.staged, icons.unstaged },
-    ["??"] = { icons.untracked },
-    ["R "] = { icons.renamed },
-    [" R"] = { icons.renamed },
-    ["RM"] = { icons.unstaged, icons.renamed },
-    ["UU"] = { icons.unmerged },
-    ["UD"] = { icons.unmerged },
-    ["UA"] = { icons.unmerged },
-    [" D"] = { icons.deleted },
-    ["D "] = { icons.deleted },
-    ["DA"] = { icons.unstaged },
-    ["RD"] = { icons.deleted },
-    ["DD"] = { icons.deleted },
-    ["DU"] = { icons.deleted, icons.unmerged },
-    ["!!"] = { icons.ignored },
-    dirty = { icons.unstaged },
-  }
-end
-
-local function build_hl_table()
-  local file = {
-    ["M "] = "NvimTreeFileStaged",
-    ["C "] = "NvimTreeFileStaged",
-    ["AA"] = "NvimTreeFileStaged",
-    ["AD"] = "NvimTreeFileStaged",
-    ["MD"] = "NvimTreeFileStaged",
-    ["T "] = "NvimTreeFileStaged",
-    ["TT"] = "NvimTreeFileStaged",
-    [" M"] = "NvimTreeFileDirty",
-    ["CM"] = "NvimTreeFileDirty",
-    [" C"] = "NvimTreeFileDirty",
-    [" T"] = "NvimTreeFileDirty",
-    ["MM"] = "NvimTreeFileDirty",
-    ["AM"] = "NvimTreeFileDirty",
-    dirty = "NvimTreeFileDirty",
-    ["A "] = "NvimTreeFileStaged",
-    ["??"] = "NvimTreeFileNew",
-    ["AU"] = "NvimTreeFileMerge",
-    ["UU"] = "NvimTreeFileMerge",
-    ["UD"] = "NvimTreeFileMerge",
-    ["DU"] = "NvimTreeFileMerge",
-    ["UA"] = "NvimTreeFileMerge",
-    [" D"] = "NvimTreeFileDeleted",
-    ["DD"] = "NvimTreeFileDeleted",
-    ["RD"] = "NvimTreeFileDeleted",
-    ["D "] = "NvimTreeFileDeleted",
-    ["R "] = "NvimTreeFileRenamed",
-    ["RM"] = "NvimTreeFileRenamed",
-    [" R"] = "NvimTreeFileRenamed",
-    ["!!"] = "NvimTreeFileIgnored",
-    [" A"] = "none",
-  }
-
-  local folder = {}
-  for k, v in pairs(file) do
-    folder[k] = v:gsub("File", "Folder")
-  end
-
-  return file, folder
-end
-
-local function nil_() end
-
-local function warn_status(git_status)
-  notify.warn(string.format("Unrecognized git state '%s'", git_status))
-end
-
---@param node table
---@return HighlightedString[]|nil
-local function get_icons_(node)
-  local git_status = explorer_node.get_git_status(node)
-  if git_status == nil then
-    return nil
-  end
-
-  local inserted = {}
-  local iconss = {}
-
-  for _, s in pairs(git_status) do
-    local icons = M.git_icons[s]
-    if not icons then
-      if not M.config.highlight_git then
-        warn_status(s)
-      end
-      return nil
-    end
-
-    for _, icon in pairs(icons) do
-      if #icon.str > 0 then
-        if not inserted[icon] then
-          table.insert(iconss, icon)
-          inserted[icon] = true
-        end
-      end
-    end
-  end
-
-  if #iconss == 0 then
-    return nil
-  end
-
-  -- sort icons so it looks slightly better
-  table.sort(iconss, function(a, b)
-    return a.ord < b.ord
-  end)
-
-  return iconss
-end
-
-function M.setup_signs(i)
-  vim.fn.sign_define("NvimTreeGitDirty", { text = i.unstaged, texthl = "NvimTreeGitDirty" })
-  vim.fn.sign_define("NvimTreeGitStaged", { text = i.staged, texthl = "NvimTreeGitStaged" })
-  vim.fn.sign_define("NvimTreeGitMerge", { text = i.unmerged, texthl = "NvimTreeGitMerge" })
-  vim.fn.sign_define("NvimTreeGitRenamed", { text = i.renamed, texthl = "NvimTreeGitRenamed" })
-  vim.fn.sign_define("NvimTreeGitNew", { text = i.untracked, texthl = "NvimTreeGitNew" })
-  vim.fn.sign_define("NvimTreeGitDeleted", { text = i.deleted, texthl = "NvimTreeGitDeleted" })
-  vim.fn.sign_define("NvimTreeGitIgnored", { text = i.ignored, texthl = "NvimTreeGitIgnored" })
-end
-
-local function get_highlight_(node)
-  local git_status = explorer_node.get_git_status(node)
-  if git_status == nil then
-    return
-  end
-
-  if node.nodes then
-    return M.folder_hl[git_status[1]]
-  else
-    return M.file_hl[git_status[1]]
-  end
-end
-
-function M.setup(opts)
-  M.config = opts.renderer
-
-  M.git_icons = build_icons_table(opts.renderer.icons.glyphs.git)
-
-  M.file_hl, M.folder_hl = build_hl_table()
-
-  if opts.renderer.icons.git_placement == "signcolumn" then
-    M.setup_signs(opts.renderer.icons.glyphs.git)
-  end
-
-  if opts.renderer.icons.show.git then
-    M.get_icons = get_icons_
-  else
-    M.get_icons = nil_
-  end
-
-  if opts.renderer.highlight_git then
-    M.get_highlight = get_highlight_
-  else
-    M.get_highlight = nil_
-  end
-
-  M.git_show_on_open_dirs = opts.git.show_on_open_dirs
-end
-
-return M
--- a/lua/nvim-tree/renderer/components/modified.lua
+++ b/lua/nvim-tree/renderer/components/modified.lua
@@ -1,41 +0,0 @@
-local modified = require "nvim-tree.modified"
-
-local M = {}
-
-local HIGHLIGHT = "NvimTreeModifiedFile"
-
---return modified icon if node is modified, otherwise return empty string
---@param node table
---@return HighlightedString|nil modified icon
-function M.get_icon(node)
-  if not modified.is_modified(node) or not M.show_icon then
-    return nil
-  end
-
-  return { str = M.icon, hl = { HIGHLIGHT } }
-end
-
-function M.setup_signs()
-  vim.fn.sign_define(HIGHLIGHT, { text = M.icon, texthl = HIGHLIGHT })
-end
-
---@param node table
---@return string|nil
-function M.get_highlight(node)
-  if not modified.is_modified(node) then
-    return nil
-  end
-
-  return HIGHLIGHT
-end
-
-function M.setup(opts)
-  M.icon = opts.renderer.icons.glyphs.modified
-  M.show_icon = opts.renderer.icons.show.modified
-
-  if opts.renderer.icons.modified_placement == "signcolumn" then
-    M.setup_signs()
-  end
-end
-
-return M