fix: continue improving Windows path escaping for commands

[bwpge]

This PR addresses more edge cases with path escaping and vim commands, as noted in #1382.

After some testing, I found that only a small number of punctuation characters required the extra escape after vim.fn.fnameescape. They are: &, (, ), ;, ^, and `.

Details

Testing method used was running :luafile % with the following test.lua on a Windows machine:

-- copy/paste from neo-tree
local is_windows = vim.fn.has("win32") == 1 or vim.fn.has("win32unix") == 1

local escape_path_for_cmd = function(path)
  local escaped_path = vim.fn.fnameescape(path)
  if is_windows then
    for _, c in ipairs({ --[[ add characters as cases fail ]] }) do
      escaped_path = escaped_path:gsub("\\%" .. c, "\\%1")
    end
  end
  return escaped_path
end
-- end copy/paste

vim.fn.mkdir("tests", "p")

-- known allowed NTFS punctuation
local symbols = [[!#$%&'()+,-;=@[]^_`{}~ ]]

-- write file with a leading punctuation to a nested directory
for char in string.gmatch(symbols, ".") do
  -- double the punctuation to ensure it actually gets escaped correctly
  local f = string.format([[.\tests\%sfoo.txt]], char .. char)
  local p = escape_path_for_cmd(f)
  vim.cmd("silent w " .. p)
end

-- files outside of `tests` directory didn't get escaped correctly
for _, f in ipairs(vim.fn.glob("tests*.txt", false, true)) do
  vim.notify("Failed: " .. f, vim.log.levels.ERROR)
  os.remove(f)
end

-- these files were written to the correct path
for _, f in ipairs(vim.fn.glob("tests/*.txt", false, true)) do
  os.remove(f)
end

This testing logic could certainly be improved, I just quickly slapped this together.

The only reason I included the above is because it may be worth creating Windows path tests in the future and didn't want to lose this information.

I manually verified this fixes the issue in #1382, and tried to recreate some issues I've reported/worked on (such as #1352) and did not see any regressions. That being said, I would feel a bit better if someone could get a second pair of eyes on a Windows machine with this PR.

[bwpge]

/cc @pysan3

[burgr033]

@bwpge asked me in #1382 to pull their fork and see if I find anything odd. I worked with their fork for half an hour and couldn't really find anything out of the ordinary.

I even checked with a few other characters.

_workspace
;workspace
(workspace
)workspace
&workspace
%workspace
`workspace
´workspace
^workspace
~workspace

Everything that I could check, works fine :)

[cseickel]

Thanks for working on this!

[pysan3]

Thanks for working on this @bwpge !

Amazing work!

[bwpge]

Happy to help! And just a reminder to @burgr033 to change your config back, thanks for the assist :)

[burgr033]

thank you all <3