fix(nvim-tree#419): harden HiTest, add missing override_by_operating_system (nvim-tree#423)

* fix(nvim-tree#419): HiTest shows overrides, add missing override_by_operating_system

* fix(nvim-tree#419): HiTest harden

Author: alex-courtis

README.md

@@ -93,6 +93,16 @@ require'nvim-web-devicons'.setup {
     name = "Log"
   }
  };
+ -- same as `override` but specifically for operating system
+ -- takes effect when `strict` is true
+ override_by_operating_system = {
+  ["apple"] = {
+    icon = "",
+    color = "#A2AAAD",
+    cterm_color = "248",
+    name = "Apple",
+  },
+ };
 }
 ```
 

lua/nvim-web-devicons.lua

@@ -343,15 +343,23 @@ function M.setup(opts)
 
   local user_filename_icons = user_icons.override_by_filename
   local user_file_ext_icons = user_icons.override_by_extension
+  local user_operating_system_icons = user_icons.override_by_operating_system
 
-  icons =
-    vim.tbl_extend("force", icons, user_icons.override or {}, user_filename_icons or {}, user_file_ext_icons or {})
+  icons = vim.tbl_extend(
+    "force",
+    icons,
+    user_icons.override or {},
+    user_filename_icons or {},
+    user_file_ext_icons or {},
+    user_operating_system_icons or {}
+  )
   global_opts.override = vim.tbl_extend(
     "force",
     global_opts.override,
     user_icons.override or {},
     user_filename_icons or {},
-    user_file_ext_icons or {}
+    user_file_ext_icons or {},
+    user_operating_system_icons or {}
   )
 
   if user_filename_icons then
@@ -360,6 +368,9 @@ function M.setup(opts)
   if user_file_ext_icons then
     icons_by_file_extension = vim.tbl_extend("force", icons_by_file_extension, user_file_ext_icons)
   end
+  if user_operating_system_icons then
+    icons_by_operating_system = vim.tbl_extend("force", icons_by_operating_system, user_operating_system_icons)
+  end
 
   icons[1] = default_icon
 
@@ -375,6 +386,7 @@ function M.setup(opts)
   vim.api.nvim_create_user_command("NvimWebDeviconsHiTest", function()
     require "nvim-web-devicons.hi-test"(
       default_icon,
+      global_opts.override,
       icons_by_filename,
       icons_by_file_extension,
       icons_by_operating_system

lua/nvim-web-devicons/hi-test.lua

@@ -2,21 +2,25 @@
 ---Display all icons and their group highlighted, followed by the concrete definition
 --
 ---@class IconDisplay for :NvimTreeHiTest
----@field tag any filename, os or extension, only strings accepted
+---@field tag string filename, os or extension
 ---@field name string name without prefix
 ---@field icon string icon itself
 ---@field group string|nil :hi group name
 ---@field def string|nil :hi concrete definition
 local IconDisplay = {}
 
 ---@param o IconDisplay
----@return IconDisplay
+---@return IconDisplay|nil
 function IconDisplay:new(o)
+  if type(o.tag) ~= "string" or type(o.name) ~= "string" or type(o.icon) ~= "string" then
+    return nil
+  end
+
   setmetatable(o, self)
   self.__index = self
 
   o.group = "DevIcon" .. o.name
-  o.tag = type(o.tag) == "string" and o.tag or ""
+  o.tag = o.tag or ""
 
   -- concrete definition
   local ok, res = pcall(vim.api.nvim_cmd, { cmd = "highlight", args = { o.group } }, { output = true })
@@ -61,16 +65,20 @@ end
 ---@param header string
 ---@return number l incremented
 local function render_icons(bufnr, l, icons, header)
-  local displays = {}
   local max_tag_len = 0
   local max_name_len = 0
 
+  local displays = {}
+  ---@cast displays IconDisplay[]
+
   -- build all icon displays
   for tag, icon in pairs(icons) do
     local display = IconDisplay:new { tag = tag, name = icon.name, icon = icon.icon }
-    table.insert(displays, display)
-    max_tag_len = math.max(max_tag_len, #display.tag)
-    max_name_len = math.max(max_name_len, #display.name)
+    if display then
+      table.insert(displays, display)
+      max_tag_len = math.max(max_tag_len, #display.tag)
+      max_name_len = math.max(max_name_len, #display.name)
+    end
   end
 
   -- sort by name
@@ -92,16 +100,20 @@ end
 ---Icon, name, <tag>, concrete highlight definition
 ---tag and header follows param
 ---@param default_icon table no tag "Default"
+---@param global_override table[] all global overrides "Overrides"
 ---@param icons_by_filename table[] filename "By File Name"
 ---@param icons_by_file_extension table[] extension "By File Extension"
 ---@param icons_by_operating_system table[] os "By Operating System"
-return function(default_icon, icons_by_filename, icons_by_file_extension, icons_by_operating_system)
+return function(default_icon, global_override, icons_by_filename, icons_by_file_extension, icons_by_operating_system)
   -- create a buffer
   local bufnr = vim.api.nvim_create_buf(false, true)
 
   -- render and highlight each section
   local l = 0
   l = render_icons(bufnr, l, { default_icon }, "Default")
+  if global_override and next(global_override) then
+    l = render_icons(bufnr, l, global_override, "Overrides")
+  end
   l = render_icons(bufnr, l, icons_by_filename, "By File Name")
   l = render_icons(bufnr, l, icons_by_file_extension, "By File Extension")
   render_icons(bufnr, l, icons_by_operating_system, "By Operating System")