fix(#2004): Change path_relative to use string find and substring to avoid using regex.

- This removed the original gsub with unintentional captures in path_to_matching_str
- Fix original path_to_matching_str (no longer used, kept for future?)
- The captures creates a limit where input path cannot have more than 32 special charactors ( `.`  , `_` or `-`)l

Author: kting28

lua/nvim-tree/utils.lua

@@ -12,7 +12,7 @@ M.is_wsl = vim.fn.has "wsl" == 1
 M.is_windows = vim.fn.has "win32" == 1 or vim.fn.has "win32unix" == 1
 
 function M.path_to_matching_str(path)
-  return path:gsub("(%-)", "(%%-)"):gsub("(%.)", "(%%.)"):gsub("(%_)", "(%%_)")
+  return path:gsub("(%-)", "%%-"):gsub("(%.)", "%%."):gsub("(%_)", "%%_")
 end
 
 function M.str_find(haystack, needle)
@@ -59,7 +59,15 @@ end
 ---@param relative_to string
 ---@return string
 function M.path_relative(path, relative_to)
-  local p, _ = path:gsub("^" .. M.path_to_matching_str(M.path_add_trailing(relative_to)), "")
+  local _, r = path:find(M.path_add_trailing(relative_to), 1, true)
+  local p = path
+  if r and r < p:len() then
+    -- take the relative path starting after /
+    -- if somehow given a completely matching path,
+    -- preserve the original path. In the original gsub implementation
+    -- path == relative_to would result in empty string returned.
+    p = path:sub(r+1)
+  end
   return p
 end