feat: name/path transforms using custom user functions

Closes ahmedkhalf#124

README.md

@@ -121,6 +121,17 @@ use {
   -- * win
   scope_chdir = 'global',
 
+  -- Custom callback to allow the name to be altered before display.
+  -- Displays the tail component of the path by default.
+  -- * function(path) return vim.fn.fnamemodify(path, ":t") end
+  transform_name = nil,
+
+  -- Custom callback to allow the path to be altered before display.
+  -- Displays an absolute path by default.
+  -- Ex: to shorten /home/me/projects/my-project into ~/projects/my-project, you can use:
+  -- * function(path) return vim.fn.fnamemodify(path, ":~") end
+  transform_path = nil,
+
   -- Path where project.nvim will store the project history for use in
   -- telescope
   datapath = vim.fn.stdpath("data"),

lua/project_nvim/config.lua

@@ -37,6 +37,17 @@ M.defaults = {
   -- * win
   scope_chdir = 'global',
 
+  -- Custom callback to allow the name to be altered before display.
+  -- Displays the tail component of the path by default.
+  -- * function(path) return vim.fn.fnamemodify(path, ":t") end
+  transform_name = nil,
+
+  -- Custom callback to allow the path to be altered before display.
+  -- Displays an absolute path by default.
+  -- Ex: to shorten /home/me/projects/my-project into ~/projects/my-project, you can use:
+  -- * function(path) return vim.fn.fnamemodify(path, ":~") end
+  transform_path = nil,
+
   -- Path where project.nvim will store the project history for use in
   -- telescope
   datapath = vim.fn.stdpath("data"),

lua/telescope/_extensions/projects.lua

@@ -42,16 +42,27 @@ local function create_finder()
   })
 
   local function make_display(entry)
-    return displayer({ entry.name, { entry.value, "Comment" } })
+    return displayer({ entry.name, { entry.display_path, "Comment" } })
   end
 
   return finders.new_table({
     results = results,
     entry_maker = function(entry)
       local name = vim.fn.fnamemodify(entry, ":t")
+      local display_path = entry
+
+      if config.options.transform_name ~= nil then
+        name = config.options.transform_name(entry)
+      end
+
+      if config.options.transform_path ~= nil then
+        display_path = config.options.transform_path(entry)
+      end
+
       return {
         display = make_display,
         name = name,
+        display_path = display_path,
         value = entry,
         ordinal = name .. " " .. entry,
       }