feat(icon): file & folder symlink icon (related to #910)

Author: jackyhevey

lua/neo-tree/defaults.lua

@@ -200,6 +200,8 @@ local config = {
       folder_open = "",
       folder_empty = "󰉖",
       folder_empty_open = "󰷏",
+      folder_symlink = "",
+      file_symlink = "",
       -- The next two settings are only a fallback, if you use nvim-web-devicons and configure default icons there
       -- then these will never be used.
       default = "*",

lua/neo-tree/sources/common/components.lua

@@ -275,7 +275,11 @@ M.icon = function(config, node, state)
     elseif node:is_expanded() then
       icon = config.folder_open or "-"
     else
-      icon = config.folder_closed or "+"
+      if node.is_link then
+        icon = config.folder_symlink
+      else
+        icon = config.folder_closed or "+"
+      end
     end
   elseif node.type == "file" or node.type == "terminal" then
     local success, web_devicons = pcall(require, "nvim-web-devicons")
@@ -284,6 +288,9 @@ M.icon = function(config, node, state)
       icon = devicon or icon
       highlight = hl or highlight
     end
+    if node.is_link then
+      icon = config.file_symlink
+    end
   end
 
   local filtered_by = M.filtered_by(config, node, state)
@@ -433,7 +440,7 @@ M.indent = function(config, node, state)
   return indent
 end
 
-local get_header = function (state, label, size)
+local get_header = function(state, label, size)
   if state.sort and state.sort.label == label then
     local icon = state.sort.direction == 1 and "▲" or "▼"
     size = size - 2
@@ -442,12 +449,12 @@ local get_header = function (state, label, size)
   return string.format("%" .. size .. "s  ", label)
 end
 
-M.file_size = function (config, node, state)
+M.file_size = function(config, node, state)
   -- Root node gets column labels
   if node:get_depth() == 1 then
     return {
       text = get_header(state, "Size", 12),
-      highlight = highlights.FILE_STATS_HEADER
+      highlight = highlights.FILE_STATS_HEADER,
     }
   end
 
@@ -465,7 +472,7 @@ M.file_size = function (config, node, state)
 
   return {
     text = string.format("%12s  ", text),
-    highlight = config.highlight or highlights.FILE_STATS
+    highlight = config.highlight or highlights.FILE_STATS,
   }
 end
 
@@ -480,7 +487,7 @@ local file_time = function(config, node, state, stat_field)
     end
     return {
       text = get_header(state, label, 20),
-      highlight = highlights.FILE_STATS_HEADER
+      highlight = highlights.FILE_STATS_HEADER,
     }
   end
 
@@ -490,7 +497,7 @@ local file_time = function(config, node, state, stat_field)
   local display = seconds and os.date("%Y-%m-%d %I:%M %p", seconds) or "-"
   return {
     text = string.format("%20s  ", display),
-    highlight = config.highlight or highlights.FILE_STATS
+    highlight = config.highlight or highlights.FILE_STATS,
   }
 end
 
@@ -513,19 +520,19 @@ M.symlink_target = function(config, node, state)
   end
 end
 
-M.type = function (config, node, state)
+M.type = function(config, node, state)
   local text = node.ext or node.type
   -- Root node gets column labels
   if node:get_depth() == 1 then
     return {
       text = get_header(state, "Type", 10),
-      highlight = highlights.FILE_STATS_HEADER
+      highlight = highlights.FILE_STATS_HEADER,
     }
   end
 
   return {
     text = string.format("%10s  ", text),
-    highlight = highlights.FILE_STATS
+    highlight = highlights.FILE_STATS,
   }
 end