fix(from_entry): escape paths with $ symbol

[jamestrew]

Description

Adds support for viewing File Previews of paths with dollar symbols.
Eg. ./($lang)._index.tsx
This is a new pattern supported by Remix optional segments file based routing.

Partially fixes downstream issue nvim-telescope/telescope-file-browser.nvim#244.
This fix also applies to many of the builtin pickers.

Type of change

• Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list relevant details about your configuration

• Test A

1. Create a file touch "(\$lang)._index.ts"
2. In that created file, enter some text console.log('hello');
3. With and without the PR checked out, use :Telescope find_files and search of the file and at look the File Preview
4. Without the PR is a blank preview; with shows the contents of the file

• Test B

1. Verify other files can still be previewed find

Configuration:

• Neovim version (nvim --version):

NVIM v0.9.0-dev-1070+g2630341db
Build type: RelWithDebInfo
LuaJIT 2.1.0-beta3

• Operating system and version:
  Linux archlinux 6.1.12-arch1-1 #1 SMP PREEMPT_DYNAMIC Tue, 14 Feb 2023 22:08:08 +0000 x86_64 GNU/Linux

Checklist:

• My code follows the style guidelines of this project (stylua)
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (lua annotations)

[jamestrew]

I also want to discuss implementing the same change to this bit of code here:

telescope.nvim/lua/telescope/_.lua

Line 24 in a3f17d3

self.uv_opts.cwd = vim.fn.expand(opts.cwd)

The lack of character escaping is impacting telescope-file-browser's file navigation. More details in the linked issue above but happy to provide more contest/summary.

Also if Conni, or if there's any other plenary maintainers seeing this, I'd like to discuss implementing the same change here: https://github.com/nvim-lua/plenary.nvim/blob/253d34830709d690f013daf2853a9d21ad7accab/lua/plenary/job.lua#L68
This will support running jobs using cwd such as ./($lang)/. This is also part of the issue linked above.

[juanpprieto]

Can confirm that telescope seems to not like paths containing ( followed by $ and also with a nested folder prefixed with __ such as /app/($lang)/__public/xyz.

I noticed a few extensions choking when working with files on these paths. FWIW, this is a common file-based routing naming convention for frameworks such as NextJS and Remix.

🙏🏼

[tjdevries]

@jamestrew if there's something you'd rather do in plenary to make this easy / universally useful, then we could totally do that. What would you like to do instead if we moved this into plenary?

[tjdevries]

Also, doesn't this then break doing things like $HOME ?

[jamestrew]

@jamestrew if there's something you'd rather do in plenary to make this easy / universally useful, then we could totally do that. What would you like to do instead if we moved this into plenary?

For this PR, making this change within telescope makes sense to me since it's more to do with how the previewer takes and handles the entry_maker's entries.

I would ultimately like to do some similar character escaping in these locations:

• https://github.com/nvim-lua/plenary.nvim/blob/253d34830709d690f013daf2853a9d21ad7accab/lua/plenary/job.lua#L68

• telescope.nvim/lua/telescope/_.lua

  Line 24 in a3f17d3

  self.uv_opts.cwd = vim.fn.expand(opts.cwd)

But I wanted to get this PR through below I go around making similar changes to other areas.

Also, doesn't this then break doing things like $HOME ?

Do you mean having files/folder with the literal string $HOME (ie touch "\$HOME, mkdir "\$HOME"). That would be handle just fine. If you mean $HOME expanded, I don't think you can have that.

[Conni2461]

thanks :)