fix(utils): transform_path always return styling (#3067)

* fix(utils): transform_path always return styling

* fix docs/type hints

* [docgen] Update doc/telescope.txt
skip-checks: true

---------

Co-authored-by: Github Actions <actions@github>
This commit is contained in:
James Trew
2024-04-20 22:14:52 -04:00
committed by GitHub
parent ef75145f80
commit 7d1698f3d8
2 changed files with 6 additions and 3 deletions

View File

@@ -2592,7 +2592,8 @@ utils.transform_path({opts}, {path}) *telescope.utils.transform_path()*
{path} (string|nil) The path that should be formatted {path} (string|nil) The path that should be formatted
Return: ~ Return: ~
string: The transformed path ready to be displayed string: path to be displayed
table: The transformed path ready to be displayed with the styling
utils.has_ts_parser({lang}) *telescope.utils.has_ts_parser()* utils.has_ts_parser({lang}) *telescope.utils.has_ts_parser()*

View File

@@ -270,7 +270,8 @@ end
--- not be addressed by us --- not be addressed by us
---@param opts table: The opts the users passed into the picker. Might contains a path_display key ---@param opts table: The opts the users passed into the picker. Might contains a path_display key
---@param path string|nil: The path that should be formatted ---@param path string|nil: The path that should be formatted
---@return string, table: The transformed path ready to be displayed with the styling (or nil) ---@return string: path to be displayed
---@return table: The transformed path ready to be displayed with the styling
utils.transform_path = function(opts, path) utils.transform_path = function(opts, path)
if path == nil then if path == nil then
return "", {} return "", {}
@@ -279,13 +280,14 @@ utils.transform_path = function(opts, path)
return path, {} return path, {}
end end
---@type fun(opts:table, path: string): string
local path_display = vim.F.if_nil(opts.path_display, require("telescope.config").values.path_display) local path_display = vim.F.if_nil(opts.path_display, require("telescope.config").values.path_display)
local transformed_path = path local transformed_path = path
local path_style = {} local path_style = {}
if type(path_display) == "function" then if type(path_display) == "function" then
return path_display(opts, transformed_path) return path_display(opts, transformed_path), path_style
elseif utils.is_path_hidden(nil, path_display) then elseif utils.is_path_hidden(nil, path_display) then
return "", path_style return "", path_style
elseif type(path_display) == "table" then elseif type(path_display) == "table" then