feat(scandir): follow symlinks

Author: SunPodder

lua/plenary/scandir.lua

@@ -100,16 +100,32 @@ local gen_search_pat = function(pattern)
 end
 
 local process_item = function(opts, name, typ, current_dir, next_dir, bp, data, giti, msp)
-  if opts.hidden or name:sub(1, 1) ~= "." then
-    if typ == "directory" then
-      local entry = current_dir .. os_sep .. name
-      if opts.depth then
-        table.insert(next_dir, handle_depth(bp, entry, opts.depth))
-      else
-        table.insert(next_dir, entry)
-      end
-      if opts.add_dirs or opts.only_dirs then
-        if not giti or giti(bp, entry .. "/") then
+  if opts.symlink or typ ~= "link" then
+    if opts.symlink and typ == "link" then
+      typ = uv.fs_stat(current_dir .. os_sep .. name).type
+    end
+
+    if opts.hidden or name:sub(1, 1) ~= "." then
+      if typ == "directory" then
+        local entry = current_dir .. os_sep .. name
+        if opts.depth then
+          table.insert(next_dir, handle_depth(bp, entry, opts.depth))
+        else
+          table.insert(next_dir, entry)
+        end
+        if opts.add_dirs or opts.only_dirs then
+          if not giti or giti(bp, entry .. "/") then
+            if not msp or msp(entry) then
+              table.insert(data, entry)
+              if opts.on_insert then
+                opts.on_insert(entry, typ)
+              end
+            end
+          end
+        end
+      elseif not opts.only_dirs then
+        local entry = current_dir .. os_sep .. name
+        if not giti or giti(bp, entry) then
           if not msp or msp(entry) then
             table.insert(data, entry)
             if opts.on_insert then
@@ -118,16 +134,6 @@ local process_item = function(opts, name, typ, current_dir, next_dir, bp, data,
           end
         end
       end
-    elseif not opts.only_dirs then
-      local entry = current_dir .. os_sep .. name
-      if not giti or giti(bp, entry) then
-        if not msp or msp(entry) then
-          table.insert(data, entry)
-          if opts.on_insert then
-            opts.on_insert(entry, typ)
-          end
-        end
-      end
     end
   end
 end
@@ -146,6 +152,7 @@ end
 --   opts.search_pattern (regex):     regex for which files will be added, string, table of strings, or fn(e) -> bool
 --   opts.on_insert(entry):           Will be called for each element
 --   opts.silent (bool):              if true will not echo messages that are not accessible
+--   opts.symlink (bool):             if true will follow symlinks
 -- @return array with files
 m.scan_dir = function(path, opts)
   opts = opts or {}

tests/plenary/job.symlink

@@ -0,0 +1 @@
+job

tests/plenary/scandir_spec.lua

@@ -65,6 +65,14 @@ describe("scandir", function()
       eq(false, contains(dirs, "./asdf/asdf/adsf.lua"))
     end)
 
+    it("with symlinks", function()
+      local dirs = scan.scan_dir(".", { symlink = true })
+      eq("table", type(dirs))
+      eq(true, contains(dirs, "./tests/plenary/job.symlink/validation_spec.lua"))
+      eq(true, contains(dirs, "./README.md"))
+      eq(true, contains(dirs, "./lua/plenary/job.lua"))
+    end)
+
     it("with add directories", function()
       local dirs = scan.scan_dir(".", { add_dirs = true })
       eq("table", type(dirs))