feat: Add ability to have a user defined function to format the path display (#1000)

1 files changed, 9 insertions, 0 deletions

diff --git a/lua/telescope/config.lua b/lua/telescope/config.lua
index e5a3ead..d7962c4 100644
--- a/lua/telescope/config.lua
+++ b/lua/telescope/config.lua
@@ -190,6 +190,15 @@ local telescope_defaults = {
 
     path_display can also be set to 'hidden' string to hide file names
 
+    path_display can also be set to a function for custom formatting of
+    the path display. Example:
+
+        -- Format path as "file.txt (path\to\file\)"
+        path_display = function(opts, path)
+          local tail = require("telescope.utils").path_tail(path)
+          return string.format("%s (%s)", tail, path)
+        end,
+
     Default: {}]]
   },