fix(#2352): windows: escape special filename characters on edit

[davisthedev]

fixes #2352

• add check if environment is windows
• if windows, escape special characters

This works on windows, will need additional linux/mac testing.

[alex-courtis]

Looks good, behind a feature flag.

Do we need to do the same for other actions such as node.open.replace_tree_buffer or node.open.tab?

We might also be able to enhance utils.canonical_path to achieve this fix.

[gegoune]

We definitely should have dedicated function to do that

[davisthedev]

I am happy to add this in other areas or let someone with more knowledge handle it and I can test.

I am not sure if there would be any adverse effects to other pieces of code with the escaping.
That is why I only made the change at the last point.

[alex-courtis]

I am happy to add this in other areas or let someone with more knowledge handle it and I can test.

I am confident it your abilities.

I am not sure if there would be any adverse effects to other pieces of code with the escaping. That is why I only made the change at the last point.

We can't cover every possible case, however we can:

1. Test and maybe fix the different actions that edit e.g. open in tab, open in place etc.
2. Test all codepaths that lead to this common function.

This is behind the feature flag so we can be confident.

[davisthedev]

I did not have any issues with node.open.replace_tree_buffer or node.open.tab.
I did move the code to its own utils function so it can be used if the problem is found elswhere.

[alex-courtis]

Many thanks for your contribution. I'll get back to this one on the weekend.

I was tempted to put this everywhere we use a fnameescape however it's safest just to fix known issues.

[davisthedev]

I don't know if the change even needs to go everywhere fnameescape is used. The issue only seems to happen whenever the path is handed over to neovim to create a buffer. It seems like everything is fine inside nvim-tree.

I am working on a similar merge for telescope, and it has the same thing. It only has this problem when it tries to open the file in a buffer or window. So I think the root of might actually be fixable inside neovim, but I am not ready to work on that codebase yet.

[alex-courtis]

It only has this problem when it tries to open the file in a buffer or window. So I think the root of might actually be fixable inside neovim, but I am not ready to work on that codebase yet.

That sounds quite reasonable. We are escaping paths using vim's api, it's just these special cases that are not correct.

We might encounter an issue if this is fixed in nvim, however we cannot do anything until that time.

[alex-courtis]

Many thanks for your contribution

[xarthurx]

It only has this problem when it tries to open the file in a buffer or window. So I think the root of might actually be fixable inside neovim, but I am not ready to work on that codebase yet.

That sounds quite reasonable. We are escaping paths using vim's api, it's just these special cases that are not correct.

We might encounter an issue if this is fixed in nvim, however we cannot do anything until that time.

neovim/neovim#24542

I don't expect they will change it in the near future.